From d520f407f51cd6639a2d779a587fe8419728d192 Mon Sep 17 00:00:00 2001 From: Robert Wolff Date: Wed, 15 Jan 2025 11:08:34 +0100 Subject: [PATCH] fix minor stuff, move lychee.toml to .lychee.toml --- .forgejo/workflows/links.yml | 4 +--- .forgejo/workflows/pr.yml | 2 +- lychee.toml => .lychee.toml | 1 + docs/admin/runner-installation.md | 2 +- docs/user/oauth2-provider.md | 12 ++++++------ docs/user/packages/arch.md | 2 +- 6 files changed, 11 insertions(+), 12 deletions(-) rename lychee.toml => .lychee.toml (96%) diff --git a/.forgejo/workflows/links.yml b/.forgejo/workflows/links.yml index 7f2e1193..3f8204ac 100644 --- a/.forgejo/workflows/links.yml +++ b/.forgejo/workflows/links.yml @@ -17,14 +17,12 @@ jobs: - name: Install lychee run: | - curl -sLO "https://github.com/lycheeverse/lychee/releases/download/v0.15.0/lychee-v0.15.0-x86_64-unknown-linux-gnu.tar.gz" curl -sLO "https://github.com/lycheeverse/lychee/releases/download/lychee-v0.18.0/lychee-x86_64-unknown-linux-gnu.tar.gz" tar -xvzf "lychee-x86_64-unknown-linux-gnu.tar.gz" - rm "lychee-x86_64-unknown-linux-gnu.tar.gz" - name: Link Checker id: lychee - run: ./lychee docs v7/docs --format markdown + run: ./lychee --config .lychee.toml docs v7/docs - name: Update issue if: '!cancelled()' diff --git a/.forgejo/workflows/pr.yml b/.forgejo/workflows/pr.yml index 9e57ca8e..15ad6199 100644 --- a/.forgejo/workflows/pr.yml +++ b/.forgejo/workflows/pr.yml @@ -24,7 +24,7 @@ jobs: with: write_changes: true - name: check typos result - run: git diff --exit-code + run: 'git diff --exit-code --word-diff || ( echo "Hint: Fix misspelled words or add false positives in .typos.toml" && false )' - name: scripts/cli-docs.sh run: | scripts/cli-docs.sh run ${{ env.GITHUB_BASE_REF }} > docs/admin/command-line.md diff --git a/lychee.toml b/.lychee.toml similarity index 96% rename from lychee.toml rename to .lychee.toml index a08396f8..e5c01cec 100644 --- a/lychee.toml +++ b/.lychee.toml @@ -1,4 +1,5 @@ no_progress = true +format = "markdown" output = "report.md" accept = ["200", "429"] scheme = ["https", "http"] diff --git a/docs/admin/runner-installation.md b/docs/admin/runner-installation.md index 29afedce..8e662292 100644 --- a/docs/admin/runner-installation.md +++ b/docs/admin/runner-installation.md @@ -501,7 +501,7 @@ curl -s -o /dev/null http://ipv6.google.com To actually enable IPv6 with `forgejo-runner exec`, the flag `--enable-ipv6` must be provided. If you run this again with `forgejo-runner exec --enable-ipv6`, the job should succeed: -```shell-session +```shellsession $ forgejo-runner exec --enable-ipv6 ... [ipv6.yml/ipv6] ✅ Success - Main apt update; apt install --yes curl diff --git a/docs/user/oauth2-provider.md b/docs/user/oauth2-provider.md index 15d8e0d2..a2317c27 100644 --- a/docs/user/oauth2-provider.md +++ b/docs/user/oauth2-provider.md @@ -121,7 +121,7 @@ In this example https://v7.next.forgejo.org will be configured to add the option 1. Redirect the user to the authorization endpoint in order to get their consent for accessing the resources: - ```curl + ```http https://[YOUR-FORGEJO-URL]/login/oauth/authorize?client_id=CLIENT_ID&redirect_uri=REDIRECT_URI&response_type=code&state=STATE ``` @@ -129,13 +129,13 @@ In this example https://v7.next.forgejo.org will be configured to add the option The user will now be asked to authorize your application. If they authorize it, the user will be redirected to the `REDIRECT_URL`, for example: - ```curl + ```http https://[REDIRECT_URI]?code=RETURNED_CODE&state=STATE ``` 2. Using the provided `code` from the redirect, you can request a new application and refresh token. The access token endpoint accepts POST requests with `application/json` and `application/x-www-form-urlencoded` body, for example: - ```curl + ```http POST https://[YOUR-FORGEJO-URL]/login/oauth/access_token ``` @@ -183,7 +183,7 @@ After you have generated this values, you can continue with your request. 1. Redirect the user to the authorization endpoint in order to get their consent for accessing the resources: - ```curl + ```http https://[YOUR-FORGEJO-URL]/login/oauth/authorize?client_id=CLIENT_ID&redirect_uri=REDIRECT_URI&response_type=code&code_challenge_method=CODE_CHALLENGE_METHOD&code_challenge=CODE_CHALLENGE&state=STATE ``` @@ -193,13 +193,13 @@ After you have generated this values, you can continue with your request. The user will now be asked to authorize your application. If they authorize it, the user will be redirected to the `REDIRECT_URL`, for example: - ```curl + ```http https://[REDIRECT_URI]?code=RETURNED_CODE&state=STATE ``` 2. Using the provided `code` from the redirect, you can request a new application and refresh token. The access token endpoint accepts POST requests with `application/json` and `application/x-www-form-urlencoded` body, for example: - ```curl + ```http POST https://[YOUR-FORGEJO-URL]/login/oauth/access_token ``` diff --git a/docs/user/packages/arch.md b/docs/user/packages/arch.md index 41b126aa..801a60b8 100644 --- a/docs/user/packages/arch.md +++ b/docs/user/packages/arch.md @@ -28,7 +28,7 @@ curl -X PUT \ First, you need to update your pacman configuration, adding following lines : -```conf +```ini [{owner}.{group}.{domain}] SigLevel = Required Server = https://{domain}/api/packages/{owner}/arch/{group}/{architecture}