From eee06d527edc5bd768bd90af40e8d15a7cea1c20 Mon Sep 17 00:00:00 2001 From: adrsham <7330099+adrsham@users.noreply.github.com> Date: Sun, 28 Jul 2024 08:00:40 -0700 Subject: [PATCH] website/docs: fix typos in passwordless setup guide (#10661) * Update typos in passwordless setup guide Some key words used in the setup are incorrect and caused confusion for me trying to setup passwordless flow. User should pick Authentication from the "Designation" drop down when creating a flow. Then the stage created should be "Authenticator Validation Stage", not Authentication. Signed-off-by: adrsham <7330099+adrsham@users.noreply.github.com> * ci: fix docker push Signed-off-by: Jens Langhammer * cache only when pushing Signed-off-by: Jens Langhammer * only attest when pushing image Signed-off-by: Jens Langhammer --------- Signed-off-by: adrsham <7330099+adrsham@users.noreply.github.com> Signed-off-by: Jens Langhammer Co-authored-by: Jens Langhammer --- .github/actions/docker-push-variables/push_vars.py | 2 +- .github/workflows/ci-main.yml | 5 +++-- .github/workflows/ci-outpost.yml | 5 +++-- website/docs/flow/stages/authenticator_validate/index.md | 4 ++-- 4 files changed, 9 insertions(+), 7 deletions(-) diff --git a/.github/actions/docker-push-variables/push_vars.py b/.github/actions/docker-push-variables/push_vars.py index 5a88e0943f..94d3b42088 100644 --- a/.github/actions/docker-push-variables/push_vars.py +++ b/.github/actions/docker-push-variables/push_vars.py @@ -7,7 +7,7 @@ from time import time parser = configparser.ConfigParser() parser.read(".bumpversion.cfg") -should_build = str(os.environ.get("DOCKER_USERNAME", None) is not None).lower() +should_build = str(len(os.environ.get("DOCKER_USERNAME", "")) > 0).lower() branch_name = os.environ["GITHUB_REF"] if os.environ.get("GITHUB_HEAD_REF", "") != "": diff --git a/.github/workflows/ci-main.yml b/.github/workflows/ci-main.yml index 53473a57d3..236e3063dd 100644 --- a/.github/workflows/ci-main.yml +++ b/.github/workflows/ci-main.yml @@ -255,14 +255,15 @@ jobs: build-args: | GIT_BUILD_HASH=${{ steps.ev.outputs.sha }} cache-from: type=registry,ref=ghcr.io/goauthentik/dev-server:buildcache - cache-to: type=registry,ref=ghcr.io/goauthentik/dev-server:buildcache,mode=max + cache-to: ${{ steps.ev.outputs.shouldBuild == 'true' && 'type=registry,ref=ghcr.io/goauthentik/dev-server:buildcache,mode=max' || '' }} platforms: linux/${{ matrix.arch }} - uses: actions/attest-build-provenance@v1 id: attest + if: ${{ steps.ev.outputs.shouldBuild == 'true' }} with: subject-name: ${{ steps.ev.outputs.imageNames }} subject-digest: ${{ steps.push.outputs.digest }} - push-to-registry: ${{ steps.ev.outputs.shouldBuild == 'true' }} + push-to-registry: true pr-comment: needs: - build diff --git a/.github/workflows/ci-outpost.yml b/.github/workflows/ci-outpost.yml index d81bc57882..a7191c82ac 100644 --- a/.github/workflows/ci-outpost.yml +++ b/.github/workflows/ci-outpost.yml @@ -110,13 +110,14 @@ jobs: platforms: linux/amd64,linux/arm64 context: . cache-from: type=registry,ref=ghcr.io/goauthentik/dev-${{ matrix.type }}:buildcache - cache-to: type=registry,ref=ghcr.io/goauthentik/dev-${{ matrix.type }}:buildcache,mode=max + cache-to: ${{ steps.ev.outputs.shouldBuild == 'true' && 'type=registry,ref=ghcr.io/goauthentik/dev-${{ matrix.type }}:buildcache,mode=max' || '' }} - uses: actions/attest-build-provenance@v1 id: attest + if: ${{ steps.ev.outputs.shouldBuild == 'true' }} with: subject-name: ${{ steps.ev.outputs.imageNames }} subject-digest: ${{ steps.push.outputs.digest }} - push-to-registry: ${{ steps.ev.outputs.shouldBuild == 'true' }} + push-to-registry: true build-binary: timeout-minutes: 120 needs: diff --git a/website/docs/flow/stages/authenticator_validate/index.md b/website/docs/flow/stages/authenticator_validate/index.md index ab270ed690..33f163051e 100644 --- a/website/docs/flow/stages/authenticator_validate/index.md +++ b/website/docs/flow/stages/authenticator_validate/index.md @@ -43,9 +43,9 @@ Firefox has some known issues regarding FIDO (see https://bugzilla.mozilla.org/s Passwordless authentication currently only supports WebAuthn devices, like security keys and biometrics. For an alternate passwordless setup, see [Password stage](../password/index.md#passwordless-login), which supports other types. -To configure passwordless authentication, create a new Flow with the delegation set to _Authentication_. +To configure passwordless authentication, create a new Flow with the designation set to _Authentication_. -As first stage, add an _Authentication validation_ stage, with the WebAuthn device class allowed. +As first stage, add an _Authenticator validation_ stage, with the WebAuthn device class allowed. After this stage you can bind any additional verification stages. As final stage, bind a _User login_ stage.