Skip to content

website: Fix issue where OpenAPI docs template generates semi-synthet… #14674

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

Merged
merged 2 commits into from
May 26, 2025

Conversation

GirlBossRush
Copy link
Contributor

@GirlBossRush GirlBossRush commented May 24, 2025

…ic title.

Details

This PR fixes an issue stemming from a change introduced in the latest OpenAPI doc generator. Generated markdown files which apply hide_title should be exempt from the linter check for incorrectly placed badges.


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 a review from fheisler May 24, 2025 17:49
@GirlBossRush GirlBossRush self-assigned this May 24, 2025
@GirlBossRush GirlBossRush requested a review from a team as a code owner May 24, 2025 17:49
Copy link

netlify bot commented May 24, 2025

Deploy Preview for authentik-docs canceled.

Name Link
🔨 Latest commit 5dd243f
🔍 Latest deploy log https://app.netlify.com/projects/authentik-docs/deploys/683443c5ce437600083aefe8

Copy link

netlify bot commented May 24, 2025

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 5dd243f
🔍 Latest deploy log https://app.netlify.com/projects/authentik-storybook/deploys/683443c5f17dee000897bc7c

Copy link

codecov bot commented May 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.70%. Comparing base (620c95d) to head (5dd243f).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #14674      +/-   ##
==========================================
- Coverage   92.75%   92.70%   -0.06%     
==========================================
  Files         814      814              
  Lines       41901    41901              
==========================================
- Hits        38867    38846      -21     
- Misses       3034     3055      +21     
Flag Coverage Δ
e2e 47.69% <ø> (-0.08%) ⬇️
integration 24.42% <ø> (ø)
unit 90.58% <ø> (ø)

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 enabled auto-merge (squash) May 24, 2025 18:17
@GirlBossRush GirlBossRush force-pushed the fix-openapi-docs-template branch from 05cca95 to 5dd243f Compare May 26, 2025 10:34
@GirlBossRush GirlBossRush merged commit afc9847 into main May 26, 2025
89 checks passed
@GirlBossRush GirlBossRush deleted the fix-openapi-docs-template branch May 26, 2025 10:50
Copy link
Contributor

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-5dd243fe97e4b3215a0ab976353ff763ce9d8312
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
global:
    image:
        repository: ghcr.io/goauthentik/dev-server
        tag: gh-5dd243fe97e4b3215a0ab976353ff763ce9d8312

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

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