diff --git a/.forgejo/workflows/pr.yml b/.forgejo/workflows/pr.yml index bad99981..cbbab987 100644 --- a/.forgejo/workflows/pr.yml +++ b/.forgejo/workflows/pr.yml @@ -1,89 +1,74 @@ name: pr on: - pull_request_target: + pull_request: jobs: preview: runs-on: docker container: image: data.forgejo.org/oci/ci:1 + env: + SITE_ORIGIN: 'https://${{ forge.event.repository.owner.username }}.preview.codeberg.page' + SITE_BASEPATH: '/${{ forge.event.repository.name }}@${{ forge.event.number }}/' steps: - - uses: https://data.forgejo.org/actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 + - name: clone website + uses: https://data.forgejo.org/actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 with: - ref: ${{ forgejo.event.pull_request.head.sha }} + repository: forgejo/website + ref: main + submodules: true + - name: remove existing docs + run: | + rm -rf forgejo-docs/${{ forge.event.pull_request.base.ref }}/ + - name: clone docs branch + uses: https://data.forgejo.org/actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3 + with: + ref: ${{ forge.event.pull_request.head.sha }} + path: forgejo-docs/${{ forge.event.pull_request.base.ref }} - name: lint - env: - GITHUB_TOKEN: override - FORGEJO_TOKEN: override + working-directory: forgejo-docs/${{ forge.event.pull_request.base.ref }} run: | npm install -g corepack@latest corepack enable - pnpm install --frozen-lockfile - pnpm run lint:remark - pnpm run format:prettier + pnpm --ignore-workspace install --frozen-lockfile + pnpm --ignore-workspace run lint:remark + pnpm --ignore-workspace run format:prettier git diff --exit-code - name: run typos uses: https://data.forgejo.org/crate-ci/typos@37bb98842b0d8c4ffebdb75301a13db0267cef89 # v1.47.2 with: write_changes: true - - name: check typos result - env: - GITHUB_TOKEN: override - FORGEJO_TOKEN: override - run: 'git diff --exit-code --word-diff || ( echo "Hint: Fix misspelled words or add false positives in .typos.toml" && false )' + files: forgejo-docs/${{ forge.event.pull_request.base.ref }} - name: scripts/cli-docs.sh - env: - GITHUB_TOKEN: override - FORGEJO_TOKEN: override + working-directory: forgejo-docs/${{ forge.event.pull_request.base.ref }} run: | - scripts/cli-docs.sh run ${{ env.GITHUB_BASE_REF }} > docs/admin/command-line.md + scripts/cli-docs.sh run ${{ forge.event.pull_request.base.ref }} > docs/admin/command-line.md git diff --exit-code - name: release-schedule - env: - GITHUB_TOKEN: override - FORGEJO_TOKEN: override + working-directory: forgejo-docs/${{ forge.event.pull_request.base.ref }} run: | pnpm run update-schedule git diff --exit-code || (echo "Error: Run 'pnpm run update-schedule' to generate the markdown release schedule and commit it" && false) - - name: get forgejo.org and move the docs - env: - GITHUB_TOKEN: override - FORGEJO_TOKEN: override - run: | - git clone --recursive --depth 1 https://codeberg.org/forgejo/website/ /tmp/website - apt-get update -qq && apt-get install -qq -y rsync - rsync -av --delete ./ /tmp/website/forgejo-docs/${{ env.GITHUB_BASE_REF }}/ - name: install - env: - GITHUB_TOKEN: override - FORGEJO_TOKEN: override run: | - cd /tmp/website corepack enable pnpm install --frozen-lockfile - name: build - env: - GITHUB_TOKEN: override - FORGEJO_TOKEN: override run: | - cd /tmp/website - colon=':' - branch=docs_pull_${{ forgejo.event.pull_request.number }} - sed -i.orig -e "s|origin$colon '.*|origin$colon 'https$colon//forgejo.codeberg.page',|" -e "s|basePathname$colon '/'|basePathname$colon '/@$branch//'|" src/config.ts - cat src/config.ts corepack enable pnpm run build - mv dist /tmp - - name: preview - if: ${{ secrets.WEBSITETOKEN != '' }} - uses: https://data.forgejo.org/forgejo/action-website-preview@3172f0cb36386db4ab6d2d9b6ca1cd4f383b58c6 # v1.1.0 + - name: publish + uses: actions/git-pages@v2 with: - directory: /tmp/dist - name: 'docs_pull_${{ github.event.pull_request.number }}' - pages-token: ${{ secrets.WEBSITETOKEN }} - repository: forgejo/docs - repository-host: codeberg.org - repository-token: ${{ secrets.WEBSITETOKEN }} - pr-number: ${{ forgejo.event.pull_request.number }} - docs-target-branch: ${{ forgejo.event.pull_request.base.ref }} + site: ${{ env.SITE_ORIGIN }}${{ env.SITE_BASEPATH }} + token: ${{ forge.token }} + source: dist/ + - name: comment + run: | + if curl -s ${{ forge.event.repository.url }}/issues/${{ forge.event.number }}/comments | grep -qv 'PR-PREVIEW-MARKER'; then + echo -n 'Posting comment: ' + curl -s -X POST ${{ forge.event.repository.url }}/issues/${{ forge.event.number }}/comments \ + -H 'Authorization: token ${{ forge.token }}' \ + --json '{"body":"Preview ready: ${{ env.SITE_ORIGIN }}${{ env.SITE_BASEPATH }}docs/${{ forge.event.pull_request.base.ref }}"}' + fi diff --git a/.typos.toml b/.typos.toml index 863be14f..12b79672 100644 --- a/.typos.toml +++ b/.typos.toml @@ -29,5 +29,5 @@ extend-ignore-identifiers-re = [ extend-exclude = [ # docs repo isn't the source of truth for this generated file; typo detection shouldn't flag issues with it because # they can't be fixed here. - "docs/admin/command-line.md" + "**/docs/admin/command-line.md" ]