-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
14 changed files
with
439 additions
and
73 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # This is an example of the docs-pr.yml workflow available from the recrwplay org | ||
| name: "Check Docs Links" | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - dev | ||
| workflow_dispatch: | ||
| # schedule: | ||
| # - cron: '00 16 * * *' | ||
|
|
||
|
|
||
| jobs: | ||
|
|
||
| docs-build: | ||
| name: Generate HTML | ||
| uses: ./.github/workflows/reusable-docs-build.yml | ||
| with: | ||
| retain-artifacts: 14 | ||
| deploy-id: 0 | ||
|
|
||
| docs-links: | ||
| name: Check links | ||
| needs: docs-build | ||
| uses: ./.github/workflows/reusable-docs-links.yml |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Use vale to lint asciidoc | ||
| name: "Check Docs style" | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - dev | ||
| workflow_dispatch: | ||
| # schedule: | ||
| # - cron: '00 16 * * *' | ||
|
|
||
| jobs: | ||
|
|
||
| docs-lint: | ||
| name: Lint docs | ||
| uses: ./.github/workflows/reusable-docs-lint.yml |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
|
|
||
| name: "Publish Branch" | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - 'dev' | ||
| workflow_dispatch: | ||
| # schedule: | ||
| # - cron: '00 16 * * *' | ||
|
|
||
| jobs: | ||
|
|
||
| docs-build: | ||
| name: Generate HTML | ||
| uses: ./.github/workflows/reusable-docs-build.yml | ||
| with: | ||
| retain-artifacts: 14 | ||
| deploy-id: 0 | ||
| package-script: 'publish-verify' | ||
| cli-options: '--extension ./.docs-tools/extensions/antora/aliases-redirects' | ||
|
|
||
| docs-verify: | ||
| name: Verify HTML | ||
| needs: docs-build | ||
| uses: ./.github/workflows/reusable-docs-verify.yml | ||
| with: | ||
| failOnWarnings: true | ||
|
|
||
| trigger-publish: | ||
| needs: docs-verify | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Trigger Publish | ||
| uses: peter-evans/repository-dispatch@bf47d102fdb849e755b0b0023ea3e81a44b6f570 # v2.1.2 | ||
| with: | ||
| token: ${{ secrets.DISPATCH_TOKEN }} | ||
| repository: neo4j/docs-publish | ||
| event-type: docs-tools | ||
| client-payload: |- | ||
| { | ||
| "org": "${{ github.repository_owner }}", | ||
| "repo": "${{ github.event.repository.name }}", | ||
| "run_id": "${{ github.run_id }}", | ||
| "branch": "${{ github.ref_name }}", | ||
| "publish_env": "dev", | ||
| "docsets": [ | ||
| "docs-tools" | ||
| ] | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| name: Check links on neo4j.com | ||
|
|
||
| on: | ||
| workflow_call: | ||
| inputs: | ||
| docs-path: | ||
| description: 'The path to the docs to check' | ||
| type: string | ||
| default: 'https://neo4j.com/docs' | ||
| docset: | ||
| description: 'The doc set to check' | ||
| type: string | ||
| default: 'operations-manual' | ||
| skipfile: | ||
| description: 'The path to the skipfile' | ||
| type: string | ||
| default: '.docs-tools/link-checker/ignore-links.txt' | ||
| retain-artifacts: | ||
| description: 'The number of days to retain artifacts' | ||
| type: number | ||
| default: 7 | ||
| workflow_dispatch: | ||
| inputs: | ||
| docs-path: | ||
| description: 'The path to the docs to check' | ||
| type: string | ||
| default: 'https://neo4j.com/docs' | ||
| docset: | ||
| description: 'The doc set to check' | ||
| type: string | ||
| default: 'operations-manual' | ||
| skipfile: | ||
| description: 'The path to the skipfile' | ||
| type: string | ||
| default: '.docs-tools/link-checker/ignore-links.txt' | ||
| retain-artifacts: | ||
| description: 'The number of days to retain artifacts' | ||
| type: number | ||
| default: 7 | ||
|
|
||
| jobs: | ||
| check-links: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| env: | ||
| DOCS_PATH: ${{ inputs.docs-path }} | ||
| DOCSET: ${{ inputs.docset }} | ||
| SKIPFILE: ${{ inputs.skipfile }} | ||
|
|
||
| steps: | ||
|
|
||
| - name: Checkout tools repo | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| repository: neo4j/docs-tools | ||
| ref: dev | ||
| sparse-checkout: | | ||
| link-checker | ||
| path: .docs-tools | ||
|
|
||
| - name: Use Node.js 16 | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: '16' | ||
|
|
||
| # - name: Install link checker | ||
| # run: npm install github:recrwplay/link-checker#v0.2.0 | ||
|
|
||
| - name: Run link checker | ||
| uses: filiph/linkcheck@f2c15a0be0d9c83def5df3edcc0f2d6582845f2d # 3.0.0 | ||
| with: | ||
| arguments: $DOCS_PATH/$DOCSET --skip-file $SKIPFILE -e |
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
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
Oops, something went wrong.