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 1 commit into
base: main
Choose a base branch
from

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 908679d
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/679a863acd7379000890330f
😎 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 908679d
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/679a863aa337920008685409
😎 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.77%. Comparing base (773c57b) to head (908679d).
Report is 10 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #12700      +/-   ##
==========================================
+ Coverage   92.75%   92.77%   +0.02%     
==========================================
  Files         769      769              
  Lines       38929    38929              
==========================================
+ Hits        36108    36116       +8     
+ Misses       2821     2813       -8     
Flag Coverage Δ
e2e 48.63% <ø> (+0.06%) ⬆️
integration 24.60% <ø> (ø)
unit 90.39% <ø> (-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.

Makefile Show resolved Hide resolved
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
website/package.json Outdated Show resolved Hide resolved
@GirlBossRush GirlBossRush requested a review from rissson January 17, 2025 03:44
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
manage.py Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
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

@@ -134,7 +134,7 @@ module.exports = async function (): Promise<Config> {
docsPluginId: "docs",
config: {
authentik: {
specPath: "static/schema.yaml",
specPath: "static/schema.yml",
Copy link
Member

Choose a reason for hiding this comment

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

We should add a redirect for this in the netlify.toml

@rissson rissson requested a review from BeryJu January 29, 2025 11:08
- 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 1f6466d to 908679d Compare January 29, 2025 19:49
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.

3 participants