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

docs: update full-dev-setup docs #7205

Merged
merged 1 commit into from
Oct 18, 2023
Merged

docs: update full-dev-setup docs #7205

merged 1 commit into from
Oct 18, 2023

Conversation

smusali
Copy link
Contributor

@smusali smusali commented Oct 17, 2023

Details

update the full-dev-setup docs


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)
  • The translation files have been updated (make i18n-extract)

If applicable

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

@smusali smusali added documentation Improvements or additions to documentation enhancement/confirmed Enhancements that will be implemented in the future needs_documentation Questions/Issues that require additional documentation labels Oct 17, 2023
@smusali smusali self-assigned this Oct 17, 2023
@smusali smusali requested a review from a team as a code owner October 17, 2023 22:56
@netlify
Copy link

netlify bot commented Oct 17, 2023

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit c67d442
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/652ff253416eda0008bf53e5

@netlify
Copy link

netlify bot commented Oct 17, 2023

Deploy Preview for authentik ready!

Name Link
🔨 Latest commit c67d442
🔍 Latest deploy log https://app.netlify.com/sites/authentik/deploys/652ff2536e47ee0009085e57
😎 Deploy Preview https://deploy-preview-7205--authentik.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 95 (🔴 down 1 from production)
Accessibility: 90 (no change from production)
Best Practices: 100 (no change from production)
SEO: 80 (no change from production)
PWA: -
View the detailed breakdown and full score reports

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

@notion-workspace
Copy link

@codecov
Copy link

codecov bot commented Oct 17, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (cb915bc) 90.88% compared to head (c67d442) 92.62%.
Report is 8 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #7205      +/-   ##
==========================================
+ Coverage   90.88%   92.62%   +1.74%     
==========================================
  Files         584      584              
  Lines       28680    28682       +2     
==========================================
+ Hits        26066    26568     +502     
+ Misses       2614     2114     -500     
Flag Coverage Δ
e2e 51.18% <ø> (+0.78%) ⬆️
integration 26.13% <ø> (?)
unit 89.62% <ø> (-0.01%) ⬇️

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

see 33 files with indirect coverage changes

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

@smusali smusali force-pushed the smusali/AUTH-294 branch 2 times, most recently from eeb4b16 to 61b4fa9 Compare October 17, 2023 23:12
@github-actions
Copy link
Contributor

github-actions bot commented Oct 17, 2023

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-smusali-AUTH-294-1697641927-c67d442
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-smusali-AUTH-294-1697641927-c67d442-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
image:
    repository: ghcr.io/goauthentik/dev-server
    tag: gh-smusali-AUTH-294-1697641927-c67d442

For arm64, use these values:

authentik:
    outposts:
        container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
image:
    repository: ghcr.io/goauthentik/dev-server
    tag: gh-smusali-AUTH-294-1697641927-c67d442-arm64

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

@smusali smusali enabled auto-merge (squash) October 18, 2023 07:04
@smusali smusali requested review from BeryJu, tanberry and a team October 18, 2023 09:31
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 so much @samir! Nice changes. I have a couple of small edits, otherwise LTGM!

@smusali smusali enabled auto-merge (squash) October 18, 2023 14:59
@smusali smusali merged commit 4262bd6 into main Oct 18, 2023
62 checks passed
@smusali smusali deleted the smusali/AUTH-294 branch October 18, 2023 15:11
kensternberg-authentik added a commit that referenced this pull request Oct 19, 2023
* main: (57 commits)
  stages/email: Fix query parameters getting lost in Email links (#5376)
  core/rbac: fix missing field when removing perm, add delete from object page (#7226)
  website/integrations: grafana: add Helm and Terraform config examples (#7121)
  web: bump @types/codemirror from 5.60.11 to 5.60.12 in /web (#7223)
  translate: Updates for file web/xliff/en.xlf in zh_CN (#7224)
  translate: Updates for file web/xliff/en.xlf in zh-Hans (#7225)
  website/blogs: blog about sso tax (#7202)
  web: Application wizard v2 with tests (#7004)
  web: bump API Client version (#7220)
  core: bump goauthentik.io/api/v3 from 3.2023083.7 to 3.2023083.8 (#7221)
  providers/radius: TOTP MFA support (#7217)
  web: bump API Client version (#7218)
  stage/deny: add custom message (#7144)
  docs: update full-dev-setup docs (#7205)
  enterprise: bump license usage task frequency (#7215)
  web: bump the storybook group in /web with 5 updates (#7212)
  web: bump the sentry group in /web with 2 updates (#7211)
  Revert "web: Updates to the Context and Tasks libraries from lit. (#7168)"
  web: bump @types/codemirror from 5.60.10 to 5.60.11 in /web (#7209)
  web: bump @types/chart.js from 2.9.38 to 2.9.39 in /web (#7206)
  ...
kensternberg-authentik added a commit that referenced this pull request Oct 19, 2023
* main: (119 commits)
  stages/email: Fix query parameters getting lost in Email links (#5376)
  core/rbac: fix missing field when removing perm, add delete from object page (#7226)
  website/integrations: grafana: add Helm and Terraform config examples (#7121)
  web: bump @types/codemirror from 5.60.11 to 5.60.12 in /web (#7223)
  translate: Updates for file web/xliff/en.xlf in zh_CN (#7224)
  translate: Updates for file web/xliff/en.xlf in zh-Hans (#7225)
  website/blogs: blog about sso tax (#7202)
  web: Application wizard v2 with tests (#7004)
  web: bump API Client version (#7220)
  core: bump goauthentik.io/api/v3 from 3.2023083.7 to 3.2023083.8 (#7221)
  providers/radius: TOTP MFA support (#7217)
  web: bump API Client version (#7218)
  stage/deny: add custom message (#7144)
  docs: update full-dev-setup docs (#7205)
  enterprise: bump license usage task frequency (#7215)
  web: bump the storybook group in /web with 5 updates (#7212)
  web: bump the sentry group in /web with 2 updates (#7211)
  Revert "web: Updates to the Context and Tasks libraries from lit. (#7168)"
  web: bump @types/codemirror from 5.60.10 to 5.60.11 in /web (#7209)
  web: bump @types/chart.js from 2.9.38 to 2.9.39 in /web (#7206)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement/confirmed Enhancements that will be implemented in the future needs_documentation Questions/Issues that require additional documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants