website: revise full development environment instructions by kensternberg-authentik · Pull Request #12638 · goauthentik/authentik

kensternberg-authentik · 2025-01-10T19:18:57Z

Updates the full development environment instructions to make it clear you will need both Docker and Golangci-Lint installed.

Adds the poetry-plugin-shell requirement, now that Poetry requires it.

Updates the per-platform development environment requirements to have a Linux-specific section, and update the MacOS section to include poetry-plugin-shell and golangci-lint

Moves the instructions on what to do before committing to the bottom of the document; its location was confusing and didn't clarify what steps were to be taken in what order.

Includes the instruction that, for a first-time run, you must run make migrate and make gen or the TS-API won't be built, and in turn the WebUI build would otherwise fail.

We still need instructions for Windows.

Details

REPLACE ME

Checklist

Local tests pass (ak test authentik/)
The code has been formatted (make lint-fix)

If an API change has been made

The API schema has been updated (make gen-build)

If changes to the frontend have been made

The code has been formatted (make web)

If applicable

The documentation has been updated
The documentation has been formatted (make website)

Updates the full development environment instructions to make it clear you *will* need both Docker and Golangci-Lint installed. Adds the `poetry-plugin-shell` requirement, now that Poetry requires it. Updates the per-platform development environment requirements to have a Linux-specific section, and update the MacOS section to include poetry-plugin-shell and golangci-lint Moves the instructions on what to do before committing to the bottom of the document; its location was confusing and didn't clarify what steps were to be taken in what order. Includes the instruction that, for a first-time run, you must run `make migrate` and `make gen` or the TS-API won't be built, and in turn the WebUI build would otherwise fail. We still need instructions for Windows.

netlify · 2025-01-10T19:19:14Z

✅ Deploy Preview for authentik-storybook canceled.

Name	Link
🔨 Latest commit	`64a57b4`
🔍 Latest deploy log	https://app.netlify.com/sites/authentik-storybook/deploys/678181221beb8a000845668a

netlify · 2025-01-10T19:19:14Z

✅ Deploy Preview for authentik-docs ready!

Name	Link
🔨 Latest commit	`64a57b4`
🔍 Latest deploy log	https://app.netlify.com/sites/authentik-docs/deploys/678181226fcf03000837d27e
😎 Deploy Preview	https://deploy-preview-12638--authentik-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

codecov · 2025-01-10T19:24:54Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.69%. Comparing base (29f8a82) to head (64a57b4).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #12638      +/-   ##
==========================================
- Coverage   92.75%   92.69%   -0.06%     
==========================================
  Files         769      769              
  Lines       38840    38840              
==========================================
- Hits        36025    36004      -21     
- Misses       2815     2836      +21

Flag	Coverage Δ
e2e	`48.49% <ø> (-0.12%)`	⬇️
integration	`24.63% <ø> (ø)`
unit	`90.39% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

website/docs/developer-docs/setup/full-dev-environment.md

tanberry · 2025-01-10T19:52:19Z

website/docs/developer-docs/setup/full-dev-environment.md

+    })() : "mac" }
+
+  values={[
+    {label: "MacOS", value: "mac"},


Suggested change

{label: "MacOS", value: "mac"},

{label: "macOS", value: "mac"},

website/docs/developer-docs/setup/full-dev-environment.md

tanberry

Suggested changes, but will Approve so I am not the blocker. The addition of the section about PRs is great, thanks! And the many other helpful, real-life tips.

github-actions · 2025-01-10T20:14:35Z

authentik PR Installation instructions

Instructions for docker-compose

Add the following block to your .env file:

AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-64a57b48d95260031f4b68a6d2f077c1cc3de0f1
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s

For arm64, use these values:

AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-64a57b48d95260031f4b68a6d2f077c1cc3de0f1-arm64
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s

Afterwards, run the upgrade commands from the latest release notes.

Instructions for Kubernetes

Add the following block to your values.yml file:

authentik:
    outposts:
        container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
global:
    image:
        repository: ghcr.io/goauthentik/dev-server
        tag: gh-64a57b48d95260031f4b68a6d2f077c1cc3de0f1

For arm64, use these values:

authentik:
    outposts:
        container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
global:
    image:
        repository: ghcr.io/goauthentik/dev-server
        tag: gh-64a57b48d95260031f4b68a6d2f077c1cc3de0f1-arm64

Afterwards, run the upgrade commands from the latest release notes.

* main: website: revise full development environment instructions (#12638) website: bump typescript from 5.7.2 to 5.7.3 in /website (#12620) website: bump aws-cdk from 2.174.1 to 2.175.0 in /website (#12621) ci: bump docker/setup-qemu-action from 3.2.0 to 3.3.0 (#12622) core: bump twilio from 9.4.1 to 9.4.2 (#12623) core: bump python-kadmin-rs from 0.5.2 to 0.5.3 (#12624) core: bump ruff from 0.8.6 to 0.9.0 (#12625) core: bump pydantic from 2.10.4 to 2.10.5 (#12626) core: bump google-api-python-client from 2.157.0 to 2.158.0 (#12628) core: bump goauthentik.io/api/v3 from 3.2024121.3 to 3.2024122.1 (#12629) web: bump API Client version (#12617) release: 2024.12.2 (#12615) website/docs: prepare 2024.12.2 release notes (#12614) providers/saml: fix invalid SAML Response when assertion and response are signed (#12611) core: fix error when creating new user with default path (#12609) rbac: permissions endpoint: allow authenticated users (#12608) website/docs: update customer portal (#12603) website/docs: policy for email whitelist: modernize (#12558)

…k#12638) * website: revise full development environment instructions Updates the full development environment instructions to make it clear you *will* need both Docker and Golangci-Lint installed. Adds the `poetry-plugin-shell` requirement, now that Poetry requires it. Updates the per-platform development environment requirements to have a Linux-specific section, and update the MacOS section to include poetry-plugin-shell and golangci-lint Moves the instructions on what to do before committing to the bottom of the document; its location was confusing and didn't clarify what steps were to be taken in what order. Includes the instruction that, for a first-time run, you must run `make migrate` and `make gen` or the TS-API won't be built, and in turn the WebUI build would otherwise fail. We still need instructions for Windows. * Prettier had opinions. * Format error: "macOS," not "MacOS" * Fixed some typos and cleaned up some prompts. * Fixed 'under windows' -> 'on Windows'

kensternberg-authentik requested a review from a team as a code owner January 10, 2025 19:18

tanberry reviewed Jan 10, 2025

View reviewed changes

website/docs/developer-docs/setup/full-dev-environment.md Outdated Show resolved Hide resolved

tanberry reviewed Jan 10, 2025

View reviewed changes

website/docs/developer-docs/setup/full-dev-environment.md Outdated Show resolved Hide resolved

tanberry reviewed Jan 10, 2025

View reviewed changes

website/docs/developer-docs/setup/full-dev-environment.md Outdated Show resolved Hide resolved

tanberry reviewed Jan 10, 2025

View reviewed changes

website/docs/developer-docs/setup/full-dev-environment.md Outdated Show resolved Hide resolved

tanberry approved these changes Jan 10, 2025

View reviewed changes

kensternberg-authentik added 2 commits January 10, 2025 12:09

Prettier had opinions.

257574c

Format error: "macOS," not "MacOS"

7d017b4

kensternberg-authentik added 2 commits January 10, 2025 12:19

Fixed some typos and cleaned up some prompts.

031e137

Fixed 'under windows' -> 'on Windows'

64a57b4

kensternberg-authentik merged commit 84de155 into main Jan 10, 2025

kensternberg-authentik deleted the website/full-development-environment branch January 10, 2025 20:53

kensternberg-authentik restored the website/full-development-environment branch January 10, 2025 20:53

kensternberg-authentik deleted the website/full-development-environment branch January 10, 2025 20:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

website: revise full development environment instructions#12638

website: revise full development environment instructions#12638
kensternberg-authentik merged 5 commits intomainfrom
website/full-development-environment

kensternberg-authentik commented Jan 10, 2025

Uh oh!

netlify bot commented Jan 10, 2025 •

edited

Loading

Uh oh!

netlify bot commented Jan 10, 2025 •

edited

Loading

Uh oh!

codecov bot commented Jan 10, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

tanberry Jan 10, 2025

Uh oh!

Uh oh!

Uh oh!

tanberry left a comment

Uh oh!

github-actions bot commented Jan 10, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	{label: "MacOS", value: "mac"},
	{label: "macOS", value: "mac"},

Uh oh!

Conversation

kensternberg-authentik commented Jan 10, 2025

Details

Checklist

Uh oh!

netlify bot commented Jan 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for authentik-storybook canceled.

Uh oh!

netlify bot commented Jan 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for authentik-docs ready!

Uh oh!

codecov bot commented Jan 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

tanberry Jan 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

tanberry left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jan 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

netlify bot commented Jan 10, 2025 •

edited

Loading

netlify bot commented Jan 10, 2025 •

edited

Loading

codecov bot commented Jan 10, 2025 •

edited

Loading

github-actions bot commented Jan 10, 2025 •

edited

Loading