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

Merged

Conversation

GirlBossRush
Copy link
Contributor

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 ready!

Name Link
🔨 Latest commit 6905f09
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/67c9e7aa54644100088f18c6
😎 Deploy Preview https://deploy-preview-12700--authentik-storybook.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.

Copy link

netlify bot commented Jan 16, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 6905f09
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/67c9e7aa2160050008fd77e8
😎 Deploy Preview https://deploy-preview-12700--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.

Copy link

codecov bot commented Jan 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.75%. Comparing base (71344d0) to head (6905f09).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #12700   +/-   ##
=======================================
  Coverage   92.75%   92.75%           
=======================================
  Files         793      793           
  Lines       40364    40364           
=======================================
  Hits        37438    37438           
  Misses       2926     2926           
Flag Coverage Δ
e2e 47.97% <ø> (ø)
integration 24.07% <ø> (ø)
unit 90.48% <ø> (ø)

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.

@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
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.

I can't say one way or the other on the code, but thanks for catching the misspellings!!

@GirlBossRush GirlBossRush force-pushed the onboarding-revisions-v1 branch from f69153f to 1f6466d Compare January 29, 2025 09:10
@GirlBossRush GirlBossRush requested a review from rissson January 29, 2025 10:26
Copy link
Member

@rissson rissson left a comment

Choose a reason for hiding this comment

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

One more little thing I didn't catch previously, mb

@rissson rissson requested a review from BeryJu January 29, 2025 11:08
@GirlBossRush GirlBossRush force-pushed the onboarding-revisions-v1 branch from 1f6466d to 908679d Compare January 29, 2025 19:49
@GirlBossRush GirlBossRush enabled auto-merge (squash) February 14, 2025 02:07
@rissson rissson mentioned this pull request Mar 4, 2025
6 tasks
@GirlBossRush GirlBossRush force-pushed the onboarding-revisions-v1 branch 2 times, most recently from cc71c25 to 8a3675f Compare March 5, 2025 18:12
@GirlBossRush
Copy link
Contributor Author

@BeryJu Rebased to latest main and ready for review 😁

Copy link
Member

@BeryJu BeryJu left a comment

Choose a reason for hiding this comment

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

Need to verify if we need a redirect for schema.yml on the website repo
Need to check if we need to update any docs that directly run the ak executable to add a poetry run prefix

@GirlBossRush GirlBossRush force-pushed the onboarding-revisions-v1 branch from 8a3675f to 9ba0387 Compare March 6, 2025 15:46
- Fixes typos.
- Fixes stale links.
- Tidies Makefile so that Poetry env is optional for hygiene commands.
- Remove mismatched YAML naming.
- Uses shebang on Python scripts.
- Document semver usage.
- Redirect OpenAPI schema.
@GirlBossRush GirlBossRush force-pushed the onboarding-revisions-v1 branch from 9ba0387 to 6905f09 Compare March 6, 2025 18:21
@GirlBossRush GirlBossRush merged commit cf58c56 into goauthentik:main Mar 6, 2025
84 checks passed
kensternberg-authentik added a commit that referenced this pull request Mar 7, 2025
* main:
  website: add a better edit this page element (#13391)
  web/admin: allow user lists to show active only (#13403)
  core: Tidy contributor onboarding, fix typos. (#12700)
  translate: Updates for file web/xliff/en.xlf in zh-Hans (#13418)
  translate: Updates for file web/xliff/en.xlf in zh_CN (#13417)
  lib/config: fix conn_max_age parsing (#13370)
  core: bump golang.org/x/sync from 0.11.0 to 0.12.0 (#13407)
  stages/authenticator_email: Fix Enroll dropdown in the MFA Devices page (#13404)
  core: bump golang.org/x/oauth2 from 0.27.0 to 0.28.0 (#13408)
  core: bump aws-cdk-lib from 2.181.1 to 2.182.0 (#13409)
  core: bump google-api-python-client from 2.162.0 to 2.163.0 (#13410)
  core: bump msgraph-sdk from 1.22.0 to 1.23.0 (#13411)
  core: bump jinja2 from 3.1.5 to 3.1.6 (#13412)
  web/user: ensure modal container on user-settings page is min-height: 100% (#13402)
  core, web: update translations (#13405)
  web/admin: add button to clear application cache (#13399)
  blueprints: Adjust title for MFA set up (#13400)
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.

4 participants