Skip to content

website/docs: in developer docs replace deprecated poetry shell command#13460

Merged
tanberry merged 2 commits intogoauthentik:mainfrom
dominic-r:sdko/dev-docs/poetry-env-activate
Mar 11, 2025
Merged

website/docs: in developer docs replace deprecated poetry shell command#13460
tanberry merged 2 commits intogoauthentik:mainfrom
dominic-r:sdko/dev-docs/poetry-env-activate

Conversation

@dominic-r
Copy link
Member

@dominic-r dominic-r commented Mar 11, 2025 •
edited
Loading

As of Poetry 2.0.0+, poetry shell is deprecated and no longer recommended to create virtualenvs.

Although not announced before, we seized the chance of a major release to remove the poetry shell command . Due to several issues with poetry shell, we recommend to use the new poetry env activate command instead.

This PR updates the full developer guide to replace the deprecated command with one which evaluates the output of the new command, poetry env activate, to activate the env.

Following: https://app.slack.com/archives/C088NSXCYE7/p1741659422388419

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)

@dominic-r
wip
32f1c65 
Signed-off-by: Dominic R <dominic@sdko.org>
@dominic-r dominic-r requested a review from a team as a code owner March 11, 2025 14:01
@netlify
Copy link

netlify bot commented Mar 11, 2025 •
edited
Loading

✅ Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 0c9f86d
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/67d042bacfa7e5000849d0bc

@netlify
Copy link

netlify bot commented Mar 11, 2025 •
edited
Loading

✅ Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 0c9f86d
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/67d042ba6e2dea0008b5ed6e
😎 Deploy Preview https://deploy-preview-13460--authentik-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@dominic-r
Rev
0c9f86d 
Signed-off-by: Dominic R <dominic@sdko.org>
@codecov
Copy link

codecov bot commented Mar 11, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.73%. Comparing base (b082849) to head (0c9f86d).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main   #13460   +/-   ##
=======================================
  Coverage   92.73%   92.73%           
=======================================
  Files         793      793           
  Lines       40376    40376           
=======================================
  Hits        37444    37444           
  Misses       2932     2932
Flag Coverage Δ
e2e 47.96% <ø> (-0.01%) ⬇️
integration 24.06% <ø> (ø)
unit 90.46% <ø> (+<0.01%) ⬆️

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.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@tanberry tanberry changed the title website: developer docs: replace deprecated poetry shell command website/docs: in developer docs replace deprecated poetry shell command Mar 11, 2025
@tanberry tanberry requested a review from a team March 11, 2025 14:52
tanberry
tanberry approved these changes Mar 11, 2025
View reviewed changes
Copy link
Contributor

@tanberry tanberry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @dominic-r !

@tanberry tanberry merged commit a221113 into goauthentik:main Mar 11, 2025
88 checks passed
@dominic-r dominic-r deleted the sdko/dev-docs/poetry-env-activate branch March 11, 2025 15:45
@dominic-r dominic-r mentioned this pull request Mar 13, 2025
Merged
6 tasks
rissson pushed a commit that referenced this pull request Mar 14, 2025
@dominic-r
website/docs: dev docs: full: remove note on installing shell plugin (#…
efb3803 
…13515)

In #13460 , we replaced `poetry shell` with `poetry env activate`. As a result, we no longer need to tell the user to install this plugin.

Signed-off-by: Dominic R <dominic@sdko.org>
kensternberg-authentik added a commit that referenced this pull request Apr 25, 2025
@kensternberg-authentik
Merge branch 'main' into dev
9251e60 
* main:
  stages/email: token_expiry format (#13394)
  core, web: update translations (#13438)
  website/docs: in developer docs replace deprecated poetry shell command (#13460)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@BeryJu BeryJu BeryJu approved these changes

@tanberry tanberry tanberry approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@dominic-r @BeryJu @tanberry