web: Fix docs links, a11y input descriptors by GirlBossRush · Pull Request #16671 · goauthentik/authentik

GirlBossRush · 2025-09-08T17:31:44Z

Details

This PR fixes a collection of issues that prevent doc links from using the correct domain while developing authentik. Following up on #15774, this PR also unifies a several related behaviors surrounding URL constants.

1. Version Constants

We've gradually moved runtime constants into the build step. The fixes in this PR are focused on web/packages/core/version/node.js, moving much of error-prone version string splitting into a parsed object.

2. Documentation links

Links to the docs are now injected during build time, fixing a few sources of URL mismatches such as when...

Running the backend via Docker
The pre-release docs for a version is not ready for publishing

Additionally, some doc links have depended on redirects -- They've since been updated to match their current canonical URLs.

3. Miscellaneous

♿️ Fix for screen reader while reading input helper text, such as when describing information about a field and linking to related docs.
♿️ Fix labels containing * being read as asterisk instead of required
♿️ Fix sidebar scroll positioning, expansion state
Fix whitespace in labelling
Fix table row actions alignment

netlify · 2025-09-08T17:31:51Z

✅ Deploy Preview for authentik-docs canceled.

Name	Link
🔨 Latest commit	`877093c`
🔍 Latest deploy log	https://app.netlify.com/projects/authentik-docs/deploys/68cb4e1c708cd80008e30064

netlify · 2025-09-08T17:31:51Z

✅ Deploy Preview for authentik-storybook ready!

Name	Link
🔨 Latest commit	`877093c`
🔍 Latest deploy log	https://app.netlify.com/projects/authentik-storybook/deploys/68cb4e1c052cb80008c11fae
😎 Deploy Preview	https://deploy-preview-16671--authentik-storybook.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

netlify · 2025-09-08T17:31:52Z

✅ Deploy Preview for authentik-integrations canceled.

Name	Link
🔨 Latest commit	`877093c`
🔍 Latest deploy log	https://app.netlify.com/projects/authentik-integrations/deploys/68cb4e1c4aaf2a0008bc657f

GirlBossRush · 2025-09-08T17:33:24Z

web/src/common/styles/authentik.css


 .pf-c-form__label[aria-required] .pf-c-form__label-text::after {
-    content: "*";
+    content: "*" / "Required";


TIL

https://a11ysupport.io/tests/tech__css__css_generated_content_alt

Found this while debugging links using macOS's VoiceOver

codecov · 2025-09-08T17:39:09Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.77%. Comparing base (d4f6370) to head (877093c).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #16671      +/-   ##
==========================================
- Coverage   92.82%   92.77%   -0.06%     
==========================================
  Files         838      838              
  Lines       45386    45386              
==========================================
- Hits        42130    42107      -23     
- Misses       3256     3279      +23

Flag	Coverage Δ
e2e	`46.52% <ø> (-0.08%)`	⬇️
integration	`23.50% <ø> (+<0.01%)`	⬆️
unit	`90.92% <ø> (+<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.

web/src/elements/cards/QuickActionsCard.ts

github-actions · 2025-09-09T13:15:39Z

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-877093c18b155bbed3fc8c036f52320b1cd833e0
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-877093c18b155bbed3fc8c036f52320b1cd833e0

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

GirlBossRush · 2025-09-09T13:18:31Z

web/packages/core/version/node.js

-export function readGitBuildHash() {
-    try {
-        const commit = execSync("git rev-parse HEAD", {
-            encoding: "utf8",
-            cwd: MonoRepoRoot,
-        })
-            .toString()
-            .trim();
-
-        return commit;
-    } catch (_error) {
-        console.debug("Git commit could not be read.");
-    }
-
-    return process.env.GIT_BUILD_HASH || "";
-}


Vestigial function, removed

web/src/admin/blueprints/BlueprintForm.ts

GirlBossRush · 2025-09-10T21:30:23Z

web/src/elements/tests/ak-array-input.test.ts

 const sampleItems: FooterLink[] = [
    { name: "authentik", href: "https://goauthentik.io" },
-    { name: "authentik docs", href: "https://docs.goauthentik.io/docs/" },
+    { name: "authentik docs", href: "https://docs.goauthentik.io" },


Avoiding usage of import.meta.env here since the element test doesn't use the same bundle config.

GirlBossRush · 2025-09-10T21:42:22Z

web/packages/core/version/node.js

+if (prerelease) {
+    ReleaseNotesURL = new URL("/releases", PreReleaseDocsURL);
+} else {
+    ReleaseNotesURL = new URL(`releases/${VersionPath}`, CurrentReleaseDocsURL);

-    return [AuthentikVersion, GIT_BUILD_HASH].join("+");
+    ReleaseNotesURL.hash = `fixed-in-${[major, minor, patch].join("")}`;


We might be able to make this anchor less fragile with a generic #latest-release-notes link in the docs.

web: Clean up constants. Fix attribute mapping. web: use previous function name. web: Fix sort. web: Use constant. web: Use prefix. web: keep using current release for notes.

…on state.

* main: (58 commits) web: bump the esbuild group across 2 directories with 4 updates (#16868) core, web: update translations (#16864) core: bump astral-sh/uv from 0.8.17 to 0.8.18 (#16866) website: bump @types/node from 24.5.1 to 24.5.2 in /website (#16867) web: bump @types/node from 24.5.1 to 24.5.2 in /packages/esbuild-plugin-live-reload (#16869) web: bump pino from 9.9.5 to 9.10.0 in /packages/esbuild-plugin-live-reload (#16870) web: bump @types/node from 24.5.1 to 24.5.2 in /packages/prettier-config (#16871) web: bump @types/node from 22.15.19 to 24.5.2 in /web (#16872) web: bump dompurify from 3.2.6 to 3.2.7 in /web (#16873) web: bump pino from 9.9.5 to 9.10.0 in /web (#16874) web: bump vite from 7.1.5 to 7.1.6 in /web (#16875) web: bump chromedriver from 140.0.2 to 140.0.3 in /web (#16876) lifecycle/aws: bump aws-cdk from 2.1029.1 to 2.1029.2 in /lifecycle/aws (#16877) web: Fix docs links, a11y input descriptors (#16671) website: bump the eslint group in /website with 3 updates (#16788) website: bump the build group in /website with 3 updates (#16787) web: bump the eslint group across 2 directories with 3 updates (#16790) website/docs: extends the example to include `jwt_config` for matrix/synapse (#16860) web/a11y: Flow Search (#15876) web: bump API Client version, remove Webdriver dependencies (#16836) ...

GirlBossRush requested a review from a team as a code owner September 8, 2025 17:31

GirlBossRush commented Sep 8, 2025

View reviewed changes

GirlBossRush force-pushed the fix-web-docs-links branch 3 times, most recently from 4d18682 to 2bfc025 Compare September 9, 2025 12:51

GirlBossRush commented Sep 9, 2025

View reviewed changes

web/src/elements/cards/QuickActionsCard.ts Show resolved Hide resolved

GirlBossRush self-assigned this Sep 9, 2025

GirlBossRush requested review from BeryJu and kensternberg-authentik September 9, 2025 13:08

GirlBossRush added bug Something isn't working documentation Improvements or additions to documentation a11y Features or issues related to accessibility labels Sep 9, 2025

GirlBossRush commented Sep 9, 2025

View reviewed changes

web/src/admin/blueprints/BlueprintForm.ts Show resolved Hide resolved

GirlBossRush force-pushed the fix-web-docs-links branch from b915c38 to bc91ff0 Compare September 10, 2025 21:19

GirlBossRush commented Sep 10, 2025

View reviewed changes

GirlBossRush force-pushed the fix-web-docs-links branch 2 times, most recently from 15d903b to f060627 Compare September 15, 2025 15:21

BeryJu approved these changes Sep 16, 2025

View reviewed changes

GirlBossRush force-pushed the fix-web-docs-links branch from f060627 to 3594984 Compare September 17, 2025 15:14

GirlBossRush enabled auto-merge (squash) September 17, 2025 15:14

GirlBossRush added 3 commits September 18, 2025 01:29

web: Clarify required marker when using screen reader.

4404c38

web: Mark helper text as input descriptor.

35963bc

web: Use next domain when in development.

ced4af6

web: Clean up constants. Fix attribute mapping. web: use previous function name. web: Fix sort. web: Use constant. web: Use prefix. web: keep using current release for notes.

GirlBossRush added 2 commits September 18, 2025 01:29

web: Remove whitespace.

856ba25

web: Add button labels.

ff84e8f

GirlBossRush force-pushed the fix-web-docs-links branch 3 times, most recently from 66905f1 to dedb701 Compare September 18, 2025 00:08

GirlBossRush added 2 commits September 18, 2025 02:10

web: Fix column alignment on smaller screens. Adjust actions margins.

0c0712d

web: Fix issue where sidebar entries are out of viewport. Fix expansi…

877093c

…on state.

GirlBossRush force-pushed the fix-web-docs-links branch from dedb701 to 877093c Compare September 18, 2025 00:11

GirlBossRush merged commit 17da90d into main Sep 18, 2025
107 checks passed

GirlBossRush deleted the fix-web-docs-links branch September 18, 2025 00:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

web: Fix docs links, a11y input descriptors#16671

web: Fix docs links, a11y input descriptors#16671
GirlBossRush merged 7 commits intomainfrom
fix-web-docs-links

GirlBossRush commented Sep 8, 2025 •

edited

Loading

Uh oh!

netlify bot commented Sep 8, 2025 •

edited

Loading

Uh oh!

netlify bot commented Sep 8, 2025 •

edited

Loading

Uh oh!

netlify bot commented Sep 8, 2025 •

edited

Loading

Uh oh!

GirlBossRush Sep 8, 2025 •

edited

Loading

Uh oh!

codecov bot commented Sep 8, 2025 •

edited

Loading

Uh oh!

Uh oh!

github-actions bot commented Sep 9, 2025 •

edited

Loading

Uh oh!

GirlBossRush Sep 9, 2025

Uh oh!

Uh oh!

GirlBossRush Sep 10, 2025

Uh oh!

GirlBossRush Sep 10, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

GirlBossRush commented Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

1. Version Constants

2. Documentation links

3. Miscellaneous

Uh oh!

netlify bot commented Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for authentik-docs canceled.

Uh oh!

netlify bot commented Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for authentik-storybook ready!

Uh oh!

netlify bot commented Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for authentik-integrations canceled.

Uh oh!

GirlBossRush Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

github-actions bot commented Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GirlBossRush Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

GirlBossRush Sep 10, 2025

Choose a reason for hiding this comment

Uh oh!

GirlBossRush Sep 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

GirlBossRush commented Sep 8, 2025 •

edited

Loading

netlify bot commented Sep 8, 2025 •

edited

Loading

netlify bot commented Sep 8, 2025 •

edited

Loading

netlify bot commented Sep 8, 2025 •

edited

Loading

GirlBossRush Sep 8, 2025 •

edited

Loading

codecov bot commented Sep 8, 2025 •

edited

Loading

github-actions bot commented Sep 9, 2025 •

edited

Loading