Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

core: Tidy contributor onboarding, fix typos. #12700

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

GirlBossRush
Copy link

Details

This PR contains a subset of fixes discovered when progressing through the authentik contributor guide. Highlights include:

  • Merging of disparate code spell dictionaries
  • Optional Poetry env for hygiene commands (e.g. lint, build, etc)
  • Fix for stale links, typos.

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)

@GirlBossRush GirlBossRush requested review from a team as code owners January 16, 2025 10:12
Copy link

netlify bot commented Jan 16, 2025

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit f69153f
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/67899e6e68ada700088488be

Copy link

netlify bot commented Jan 16, 2025

Deploy Preview for authentik-docs canceled.

Name Link
🔨 Latest commit f69153f
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/67899e6e68ada700088488c0

Copy link

codecov bot commented Jan 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.76%. Comparing base (84de155) to head (f69153f).
Report is 51 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #12700   +/-   ##
=======================================
  Coverage   92.75%   92.76%           
=======================================
  Files         769      769           
  Lines       38840    38898   +58     
=======================================
+ Hits        36026    36083   +57     
- Misses       2814     2815    +1     
Flag Coverage Δ
e2e 48.58% <ø> (+<0.01%) ⬆️
integration 24.62% <ø> (-0.02%) ⬇️
unit 90.40% <ø> (+<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.

coverage run manage.py test --keepdb authentik
coverage html
coverage report
poetry run coverage run manage.py test --keepdb authentik
Copy link
Member

Choose a reason for hiding this comment

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

We usually assume devs will already be in a poetry shell, but I don't think this should matter anyway.

However, in CI (.github/workflows/ci-main.yml for instance), we do poetry run make test, so that should be updated as well.

Copy link
Author

Choose a reason for hiding this comment

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

Hi @rissson!

Thanks for reviewing my PR. I'm open to either approach, but it may help to keep the prefix.

When running make test without a Poetry shell activated, make doesn't know where to find the coverage command and emits an error without a hint at the solution.

❯ make test
coverage run manage.py test --keepdb authentik
make: coverage: No such file or directory
make: *** [test] Error 1

The virtual environment instructions appear in the full-stack setup docs, but my concern is that contributors who start with the front-end or docs environments might miss the Python requirements when switching contexts.

Since ci-main.yml uses the poetry prefix consistently, would it make sense to keep it for now? We could look at removing it from both places as a separate task if you think that would be valuable.

Thanks for your feedback!

Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
@GirlBossRush GirlBossRush force-pushed the onboarding-revisions-v1 branch from fe330fd to 10893ee Compare January 16, 2025 23:19
@GirlBossRush GirlBossRush requested a review from rissson January 17, 2025 03:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants