From 48304052c9ece5cbfa787615debaecc52bec9e92 Mon Sep 17 00:00:00 2001 From: Mohd Aquib Date: Tue, 14 Jul 2026 10:59:15 +0530 Subject: [PATCH] Update GitHub Pages configuration and installation instructions - Modify `.github/workflows/docs.yml` to support an optional `PAGES_TOKEN` for GitHub Pages configuration. - Add logic to explicitly enable site deployment and use the provided token in the CI workflow if `PAGES_TOKEN` is present. - Update the JitPack dependency path in `README.md` to use the correct repository-based coordinates. --- .github/workflows/docs.yml | 12 +++++++++++- README.md | 2 +- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index b9e3c1e..c612f25 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -17,6 +17,8 @@ jobs: publish-dokka: name: Publish Dokka HTML runs-on: ubuntu-latest + env: + PAGES_TOKEN: ${{ secrets.PAGES_TOKEN }} environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} @@ -31,7 +33,15 @@ jobs: cache: gradle - name: Generate Dokka HTML run: ./gradlew dokkaGenerate - - uses: actions/configure-pages@v5 + - name: Configure GitHub Pages + if: ${{ env.PAGES_TOKEN == '' }} + uses: actions/configure-pages@v5 + - name: Configure GitHub Pages and enable site + if: ${{ env.PAGES_TOKEN != '' }} + uses: actions/configure-pages@v5 + with: + enablement: true + token: ${{ env.PAGES_TOKEN }} - uses: actions/upload-pages-artifact@v3 with: path: build/dokka/html diff --git a/README.md b/README.md index 4288726..38de562 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ flowchart LR ```kotlin repositories { maven("https://jitpack.io") } -dependencies { debugImplementation("io.github.mohdaquib:scanner-ui:") } +dependencies { debugImplementation("com.github.mohdaquib.ComposeA11yScanner:scanner-ui:") } ``` Use a debug-only dependency because the scanner is intended for development builds. `:scanner-ui` brings `:scanner-core` and `:scanner-rules` transitively.