try out remark-lint GHA #20
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Check all content (MDX) links | |
| on: | |
| pull_request: | |
| jobs: | |
| check-for-absolute-urls: | |
| name: Check for Absolute URLs | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: check for docs urls | |
| id: absolute-urls | |
| run: | | |
| FILES_WITH_ABS_URLS=$(grep -Erl "https://prisma\.io/docs|https://www\.prisma\.io/docs" content) | |
| OUTPUT="" | |
| SUCCESS=false | |
| if [ -n "${FILES_WITH_ABS_URLS}" ]; then # if there were matching files | |
| OUTPUT="The following files have absolute URLs to prisma.io/docs. Please replace them with relative URLs."$'\n' | |
| for line in ${FILES_WITH_ABS_URLS} | |
| do | |
| OUTPUT+="${line}"$'\n' | |
| done | |
| else | |
| # no matching files | |
| OUTPUT="No absolute URLs to prisma.io/docs found." | |
| SUCCESS=true | |
| fi | |
| # https://github.com/orgs/community/discussions/26288#discussioncomment-3876281 | |
| { | |
| echo 'body<<EOF' | |
| echo "$OUTPUT" | |
| echo EOF | |
| } >> "$GITHUB_OUTPUT" | |
| echo "success=${SUCCESS}" >> "$GITHUB_OUTPUT" | |
| - uses: ./.github/actions/create-or-update-comment | |
| with: | |
| pull-request: ${{ github.event.pull_request.number }} | |
| body: ${{ steps.absolute-urls.outputs.body }} | |
| body-includes: absolute URLs | |
| - name: report success | |
| run: | | |
| if ${{ steps.absolute-urls.outputs.success }}; then | |
| exit 0; | |
| else | |
| exit 1; | |
| fi | |
| remark-lint: | |
| name: runner / remark-lint | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 18 | |
| - name: Install deps | |
| run: npm install | |
| - name: Install remark presets | |
| run: npm install remark-lint-no-dead-urls | |
| - name: run remark-cli | |
| run: | | |
| npx remark-cli . -qf -e=md,mdx --use=remark-mdx --use remark-frontmatter --use remark-gfm \ | |
| --use 'remark-lint-no-dead-urls=skipLocalhost:true,skipUrlPatterns:["https://www.notion.so/prismaio","https://www.prisma.io/docs","https://dash.cloudflare.com","https://www.cloudflare.com"]' | |
| # remark-lint: | |
| # name: runner / remark-lint | |
| # runs-on: ubuntu-latest | |
| # steps: | |
| # - uses: actions/checkout@v4 | |
| # - uses: actions/setup-node@v4 | |
| # with: | |
| # node-version: 18 | |
| # - name: install remark presets | |
| # run: npm install remark-lint-no-dead-urls | |
| # shell: bash | |
| # - name: remark-lint | |
| # uses: reviewdog/action-remark-lint@v5 | |
| # with: | |
| # github_token: ${{ secrets.GITHUB_TOKEN }} | |
| # reporter: github-pr-check | |
| # remark_args: '-qf -e=md,mdx --use=remark-mdx --use remark-frontmatter --use remark-gfm --use remark-lint-no-dead-urls=skipLocalhost:true,skipUrlPatterns:["https://www.notion.so/prismaio","https://www.prisma.io/docs","https://dash.cloudflare.com","https://www.cloudflare.com"]' | |
| check-for-redirects: | |
| name: Check for needed redirects | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Create suggested redirects | |
| id: redirects | |
| run: | | |
| bash .github/workflows/scripts/generate-redirects.sh | |
| - uses: ./.github/actions/create-or-update-comment | |
| with: | |
| pull-request: ${{ github.event.pull_request.number }} | |
| body: ${{ steps.redirects.outputs.body }} | |
| body-includes: following redirects |