From 250949e272d03246e8ac85efd5ddeaf14cadf995 Mon Sep 17 00:00:00 2001 From: Neil Dewhurst Date: Tue, 16 Jan 2024 13:51:18 +0000 Subject: [PATCH 1/5] use separate workflows for checks --- .github/workflows/docs-branch-checks.yml | 54 -------------- .github/workflows/docs-links.yml | 25 +++++++ .github/workflows/docs-lint.yml | 16 +++++ ...hed-links.yml => docs-published-links.yml} | 25 ------- .../reusable-docs-published-links.yml | 72 +++++++++++++++++++ 5 files changed, 113 insertions(+), 79 deletions(-) delete mode 100644 .github/workflows/docs-branch-checks.yml create mode 100644 .github/workflows/docs-links.yml create mode 100644 .github/workflows/docs-lint.yml rename .github/workflows/{reusable-published-links.yml => docs-published-links.yml} (67%) create mode 100644 .github/workflows/reusable-docs-published-links.yml diff --git a/.github/workflows/docs-branch-checks.yml b/.github/workflows/docs-branch-checks.yml deleted file mode 100644 index dc310cb..0000000 --- a/.github/workflows/docs-branch-checks.yml +++ /dev/null @@ -1,54 +0,0 @@ -# This is an example of the docs-pr.yml workflow available from the recrwplay org -name: "Verify Branch" - -on: - push: - branches: - - dev - # schedule: - # - cron: '00 16 * * *' - workflow_dispatch: - inputs: - html: - description: 'Generate HTML' - type: boolean - required: false - default: true - links: - description: 'Check links' - type: boolean - required: false - default: true - lint: - description: 'Lint docs' - type: boolean - required: false - default: true - -jobs: - - docs-build: - if: ${{ inputs.html }} - name: Generate HTML - uses: neo4j/docs-tools/.github/workflows/reusable-docs-build.yml@dev - 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: neo4j/docs-tools/.github/workflows/reusable-docs-verify.yml@dev - - docs-links: - if: ${{ inputs.links }} - name: Check links - needs: docs-build - uses: neo4j/docs-tools/.github/workflows/reusable-docs-links.yml@dev - - docs-lint: - if: ${{ inputs.lint }} - name: Lint docs - uses: neo4j/docs-tools/.github/workflows/reusable-docs-vale.yml@dev \ No newline at end of file diff --git a/.github/workflows/docs-links.yml b/.github/workflows/docs-links.yml new file mode 100644 index 0000000..150e787 --- /dev/null +++ b/.github/workflows/docs-links.yml @@ -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: neo4j/docs-tools/.github/workflows/reusable-docs-build.yml@dev + with: + retain-artifacts: 14 + deploy-id: 0 + + docs-links: + name: Check links + needs: docs-build + uses: neo4j/docs-tools/.github/workflows/reusable-docs-links.yml@dev diff --git a/.github/workflows/docs-lint.yml b/.github/workflows/docs-lint.yml new file mode 100644 index 0000000..815a937 --- /dev/null +++ b/.github/workflows/docs-lint.yml @@ -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: neo4j/docs-tools/.github/workflows/reusable-docs-vale.yml@dev diff --git a/.github/workflows/reusable-published-links.yml b/.github/workflows/docs-published-links.yml similarity index 67% rename from .github/workflows/reusable-published-links.yml rename to .github/workflows/docs-published-links.yml index 4e63950..64ccae3 100644 --- a/.github/workflows/reusable-published-links.yml +++ b/.github/workflows/docs-published-links.yml @@ -70,28 +70,3 @@ jobs: uses: filiph/linkcheck@3.0.0 with: arguments: $DOCS_PATH/$DOCSET --skip-file $SKIPFILE -e - - # - name: Run link checker - # run: | - # npx link-checker $DOCS_PATH/$DOCSET --skip-file $SKIPFILE -e |& tee link-log.txt - # warncount=$(grep -e "[0-9]* warnings" -o link-log.txt | sed 's/ warnings//' ) - # if [ $warncount -gt 0 ]; then - # echo "::warning:: $warncount warnings" - # fi - # errorcount=$(grep -e "[0-9]* errors" -o link-log.txt | sed 's/ errors//' ) - # if [ $errorcount -gt 0 ]; then - # echo "::error:: Errors found: See the output of the Check links step for details" - # exit 1 - # fi - - # upload artifacts - - - name: Save log - uses: actions/upload-artifact@v3 - with: - name: linklog - path: link-log.txt - - # if errors, raise an issue in the repo and exit 1 to fail the workflow - # tbc... - # create an action. action needs authed token. attach log to issue. extract errors as issue text? diff --git a/.github/workflows/reusable-docs-published-links.yml b/.github/workflows/reusable-docs-published-links.yml new file mode 100644 index 0000000..64ccae3 --- /dev/null +++ b/.github/workflows/reusable-docs-published-links.yml @@ -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@v3 + 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@3.0.0 + with: + arguments: $DOCS_PATH/$DOCSET --skip-file $SKIPFILE -e From 5bb34a2d85be6c06d670250d42074a1286b639a1 Mon Sep 17 00:00:00 2001 From: Neil Dewhurst Date: Wed, 17 Jan 2024 19:47:34 +0000 Subject: [PATCH 2/5] rename vale to lint --- .github/workflows/docs-lint.yml | 2 +- .../{reusable-docs-vale.yml => reusable-docs-lint.yml} | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) rename .github/workflows/{reusable-docs-vale.yml => reusable-docs-lint.yml} (98%) diff --git a/.github/workflows/docs-lint.yml b/.github/workflows/docs-lint.yml index 815a937..0f4c5d3 100644 --- a/.github/workflows/docs-lint.yml +++ b/.github/workflows/docs-lint.yml @@ -13,4 +13,4 @@ jobs: docs-lint: name: Lint docs - uses: neo4j/docs-tools/.github/workflows/reusable-docs-vale.yml@dev + uses: neo4j/docs-tools/.github/workflows/reusable-docs-lint.yml@dev diff --git a/.github/workflows/reusable-docs-vale.yml b/.github/workflows/reusable-docs-lint.yml similarity index 98% rename from .github/workflows/reusable-docs-vale.yml rename to .github/workflows/reusable-docs-lint.yml index 7d4886c..cfee3a8 100644 --- a/.github/workflows/reusable-docs-vale.yml +++ b/.github/workflows/reusable-docs-lint.yml @@ -53,7 +53,7 @@ on: reporter: description: 'Where action messages are reported' type: string - default: 'github-pr-scheck' + default: 'github-pr-check' separator: description: 'Delimiter for input files or folders' type: string From 8f3df2e729e31ba25ef6dd25fcff3a1d6c8eed14 Mon Sep 17 00:00:00 2001 From: Nicola Vitucci Date: Tue, 16 Jan 2024 14:56:42 +0000 Subject: [PATCH 3/5] Update Vale version (#10) * Add Vale external styles to gitignore * Add Vale instructions * Add entries to vocabulary and test file * Update .gitignore to exclude IDE dirs * Move vocabularies to new format; remove unused Names.yml --- .gitignore | 8 ++++---- vale/README.adoc | 4 ++-- vale/styles/Neo4j/Names.yml | 11 ----------- .../{Vocab => config/vocabularies}/Neo4j/accept.txt | 4 ++++ .../{Vocab => config/vocabularies}/Neo4j/reject.txt | 0 .../{Vocab => config/vocabularies}/Tools/accept.txt | 0 .../{Vocab => config/vocabularies}/Tools/reject.txt | 0 vale/test-results.txt | 8 +++----- 8 files changed, 13 insertions(+), 22 deletions(-) delete mode 100644 vale/styles/Neo4j/Names.yml rename vale/styles/{Vocab => config/vocabularies}/Neo4j/accept.txt (91%) rename vale/styles/{Vocab => config/vocabularies}/Neo4j/reject.txt (100%) rename vale/styles/{Vocab => config/vocabularies}/Tools/accept.txt (100%) rename vale/styles/{Vocab => config/vocabularies}/Tools/reject.txt (100%) diff --git a/.gitignore b/.gitignore index ea8c49f..5583f6e 100644 --- a/.gitignore +++ b/.gitignore @@ -107,7 +107,7 @@ dist build/ # Exclude external styles -vale/styles -!vale/styles/Neo4j -!vale/styles/Vocab -!vale/styles/Experimental +vale/styles/Google + +# IDE +.vscode diff --git a/vale/README.adoc b/vale/README.adoc index b85cb7a..db72242 100644 --- a/vale/README.adoc +++ b/vale/README.adoc @@ -30,11 +30,11 @@ To add a new style (for example the Google style guide) in the Vale configuratio 1. Edit the `vale.ini` file to either add `Google` to the `BasedOnStyles` (to add all the style rules by default, and optionally disable some), or add single rules such as `Google.DateFormat = YES`. 2. Run `vale --config vale/.vale.ini sync` to download the new style (if it has not been downloaded before). -NOTE: Any styles added to the `vale/styles` directory except our custom ones are ignored by `git`. +NOTE: Any external styles added to the `vale/styles` directory (except our custom ones) must be added to `.gitignore`. ## Add terms to the vocabulary -You can add terms with their accepted spelling in the `accept.txt` file(s) within the `vale/Vocab` subdirectories. +You can add terms with their accepted spelling in the `accept.txt` file(s) within the `vale/config/vocabularies` subdirectories. NOTE: Do not add entries where an entry fully contains another one, such as `Neo4j` and `Neo4j Aura`. Use the `Neo4j/Names.yml` rule for single words instead. diff --git a/vale/styles/Neo4j/Names.yml b/vale/styles/Neo4j/Names.yml deleted file mode 100644 index 7607571..0000000 --- a/vale/styles/Neo4j/Names.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: substitution -message: Use '%s' instead of '%s'. -level: error -ignorecase: true -action: - name: replace -swap: - - neo4j: Neo4j - - cypher: Cypher - - aurads: AuraDS - - auradb: AuraDB \ No newline at end of file diff --git a/vale/styles/Vocab/Neo4j/accept.txt b/vale/styles/config/vocabularies/Neo4j/accept.txt similarity index 91% rename from vale/styles/Vocab/Neo4j/accept.txt rename to vale/styles/config/vocabularies/Neo4j/accept.txt index b90dd6a..4952c90 100644 --- a/vale/styles/Vocab/Neo4j/accept.txt +++ b/vale/styles/config/vocabularies/Neo4j/accept.txt @@ -1,12 +1,16 @@ API APOC +AuraDB AuraDB Enterprise AuraDB Free AuraDB Professional +AuraDS AuraDS Enterprise AuraDS Professional CSV +Cypher Graph Data Science +Neo4j Neo4j Aura Neo4j AuraDB Neo4j AuraDS diff --git a/vale/styles/Vocab/Neo4j/reject.txt b/vale/styles/config/vocabularies/Neo4j/reject.txt similarity index 100% rename from vale/styles/Vocab/Neo4j/reject.txt rename to vale/styles/config/vocabularies/Neo4j/reject.txt diff --git a/vale/styles/Vocab/Tools/accept.txt b/vale/styles/config/vocabularies/Tools/accept.txt similarity index 100% rename from vale/styles/Vocab/Tools/accept.txt rename to vale/styles/config/vocabularies/Tools/accept.txt diff --git a/vale/styles/Vocab/Tools/reject.txt b/vale/styles/config/vocabularies/Tools/reject.txt similarity index 100% rename from vale/styles/Vocab/Tools/reject.txt rename to vale/styles/config/vocabularies/Tools/reject.txt diff --git a/vale/test-results.txt b/vale/test-results.txt index d7ddbd7..2e703f7 100644 --- a/vale/test-results.txt +++ b/vale/test-results.txt @@ -1,12 +1,10 @@ test.adoc:5:9:Vale.Terms:Use 'Neo4j Browser' instead of 'Neo4j browser'. -test.adoc:7:5:Neo4j.Names:Use 'Neo4j' instead of 'neo4j'. -test.adoc:8:5:Neo4j.Names:Use 'AuraDB' instead of 'AuraDb'. +test.adoc:7:5:Vale.Terms:Use 'Neo4j' instead of 'neo4j'. +test.adoc:8:5:Vale.Terms:Use 'AuraDB' instead of 'AuraDb'. test.adoc:9:6:Vale.Terms:Use 'Neo4j AuraDB' instead of 'Neo4j AuraDb'. -test.adoc:9:12:Neo4j.Names:Use 'AuraDB' instead of 'AuraDb'. test.adoc:10:5:Vale.Terms:Use 'AuraDB Enterprise' instead of 'AuraDB enterprise'. test.adoc:11:5:Vale.Terms:Use 'Neo4j AuraDB' instead of 'Neo4j AuraDb'. -test.adoc:11:11:Neo4j.Names:Use 'AuraDB' instead of 'AuraDb'. -test.adoc:12:10:Neo4j.Names:Use 'Cypher' instead of 'cypher'. +test.adoc:12:10:Vale.Terms:Use 'Cypher' instead of 'cypher'. test.adoc:25:5:Neo4j.Headings:'Backup and Export' should use sentence-style capitalization. test.adoc:26:5:Neo4j.Headings:'Use the Graph Catalog' should use sentence-style capitalization. test.adoc:30:11:Neo4j.SimpleWords:Use 'try' instead of 'attempt' From 138dbb1b21e191dd049e759a69d5add5994b6572 Mon Sep 17 00:00:00 2001 From: Neil Dewhurst Date: Wed, 17 Jan 2024 18:36:01 +0000 Subject: [PATCH 4/5] Use SHA instead of branch (#11) --- .github/workflows/reusable-docs-verify.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/reusable-docs-verify.yml b/.github/workflows/reusable-docs-verify.yml index cbb7c30..fcb38f0 100644 --- a/.github/workflows/reusable-docs-verify.yml +++ b/.github/workflows/reusable-docs-verify.yml @@ -25,7 +25,7 @@ jobs: - name: Analyze Antora log id: antora-log-check-test - uses: recrwplay/antora-log-analyzer@main + uses: recrwplay/antora-log-analyzer@f42057f7215a68108a2863ceecab212470e90cae with: fail-on-errors: ${{ inputs.failOnErrors }} fail-on-warnings: ${{ inputs.failOnWarnings }} From 26018a9cd916289592942f3437bbae1a803c4ace Mon Sep 17 00:00:00 2001 From: Neil Dewhurst Date: Wed, 17 Jan 2024 20:09:01 +0000 Subject: [PATCH 5/5] Fix up all the uses contexts --- .github/workflows/docs-deploy-surge.yml | 6 +++--- .github/workflows/docs-links.yml | 4 ++-- .github/workflows/docs-lint.yml | 2 +- .github/workflows/docs-pr-checks.yml | 10 +++++----- .github/workflows/docs-publish.yml | 6 +++--- .github/workflows/docs-published-links.yml | 4 ++-- .github/workflows/docs-teardown.yml | 4 ++-- .github/workflows/reusable-docs-build.yml | 10 +++++----- .github/workflows/reusable-docs-links.yml | 6 +++--- .github/workflows/reusable-docs-lint.yml | 4 ++-- .github/workflows/reusable-docs-pr-changes.yml | 4 ++-- .github/workflows/reusable-docs-published-links.yml | 4 ++-- .github/workflows/reusable-docs-verify.yml | 4 ++-- 13 files changed, 34 insertions(+), 34 deletions(-) diff --git a/.github/workflows/docs-deploy-surge.yml b/.github/workflows/docs-deploy-surge.yml index 3c99e26..dc6cf33 100644 --- a/.github/workflows/docs-deploy-surge.yml +++ b/.github/workflows/docs-deploy-surge.yml @@ -63,7 +63,7 @@ jobs: deployurl=$ORG-$REPO-$DEPLOYID.surge.sh echo "deploy-url=$deployurl" >> $GITHUB_OUTPUT - - uses: actions/setup-node@v3 + - uses: actions/setup-node@v4 with: node-version: lts/* @@ -80,7 +80,7 @@ jobs: # The changelog contains links to new and changed files in the deployed docs - name: Comment on PR (changelog) if: ${{ hashFiles('changelog') != '' }} - uses: marocchino/sticky-pull-request-comment@v2 + uses: marocchino/sticky-pull-request-comment@efaaab3fd41a9c3de579aba759d2552635e590fd #v2.8.0 with: number: ${{ steps.get-deploy-id.outputs.deploy-id }} recreate: true @@ -93,7 +93,7 @@ jobs: if: ${{ hashFiles('changelog') == '' }} env: DEPLOY_URL: ${{ steps.get-deploy-url.outputs.deploy-url }} - uses: marocchino/sticky-pull-request-comment@v2 + uses: marocchino/sticky-pull-request-comment@efaaab3fd41a9c3de579aba759d2552635e590fd #v2.8.0 with: number: ${{ steps.get-deploy-id.outputs.deploy-id }} header: docs-pr-changes diff --git a/.github/workflows/docs-links.yml b/.github/workflows/docs-links.yml index 150e787..53eabbf 100644 --- a/.github/workflows/docs-links.yml +++ b/.github/workflows/docs-links.yml @@ -14,7 +14,7 @@ jobs: docs-build: name: Generate HTML - uses: neo4j/docs-tools/.github/workflows/reusable-docs-build.yml@dev + uses: ./.github/workflows/reusable-docs-build.yml with: retain-artifacts: 14 deploy-id: 0 @@ -22,4 +22,4 @@ jobs: docs-links: name: Check links needs: docs-build - uses: neo4j/docs-tools/.github/workflows/reusable-docs-links.yml@dev + uses: ./.github/workflows/reusable-docs-links.yml diff --git a/.github/workflows/docs-lint.yml b/.github/workflows/docs-lint.yml index 0f4c5d3..97099f5 100644 --- a/.github/workflows/docs-lint.yml +++ b/.github/workflows/docs-lint.yml @@ -13,4 +13,4 @@ jobs: docs-lint: name: Lint docs - uses: neo4j/docs-tools/.github/workflows/reusable-docs-lint.yml@dev + uses: ./.github/workflows/reusable-docs-lint.yml diff --git a/.github/workflows/docs-pr-checks.yml b/.github/workflows/docs-pr-checks.yml index 528f1ac..715a2a8 100644 --- a/.github/workflows/docs-pr-checks.yml +++ b/.github/workflows/docs-pr-checks.yml @@ -10,7 +10,7 @@ jobs: # Generate HTML docs-build-pr: - uses: neo4j/docs-tools/.github/workflows/reusable-docs-build.yml@dev + uses: ./.github/workflows/reusable-docs-build.yml with: deploy-id: ${{ github.event.number }} retain-artifacts: 14 @@ -21,7 +21,7 @@ jobs: # By default, the job fails if there are errors, passes if there are warnings only. docs-verify-pr: needs: docs-build-pr - uses: neo4j/docs-tools/.github/workflows/reusable-docs-verify.yml@dev + uses: ./.github/workflows/reusable-docs-verify.yml with: failOnWarnings: true @@ -38,7 +38,7 @@ jobs: steps: - name: Get file changes id: get-file-changes - uses: tj-actions/changed-files@v41 + uses: tj-actions/changed-files@cbda684547adc8c052d50711417fa61b428a9f88 # v41.1.2 with: separator: ',' files_yaml: | @@ -53,7 +53,7 @@ jobs: docs-updates-comment-pr: if: needs.docs-build-pr.outputs.pages-listed == 'success' needs: [docs-build-pr, docs-changes-pr] - uses: neo4j/docs-tools/.github/workflows/reusable-docs-pr-changes.yml@dev + uses: ./.github/workflows/reusable-docs-pr-changes.yml with: pages-modified: ${{ needs.docs-changes-pr.outputs.pages-modified }} pages-added: ${{ needs.docs-changes-pr.outputs.pages-added }} @@ -63,7 +63,7 @@ jobs: docs-lint-pr: needs: docs-changes-pr if: needs.docs-changes-pr.outputs.asciidoc-files != '' - uses: neo4j/docs-tools/.github/workflows/reusable-docs-vale.yml@dev + uses: ./.github/workflows/reusable-docs-lint.yml with: files: ${{ needs.docs-changes-pr.outputs.asciidoc-files }} vale-fail-on-error: true diff --git a/.github/workflows/docs-publish.yml b/.github/workflows/docs-publish.yml index c3fdacc..4aebea1 100644 --- a/.github/workflows/docs-publish.yml +++ b/.github/workflows/docs-publish.yml @@ -13,7 +13,7 @@ jobs: docs-build: name: Generate HTML - uses: neo4j/docs-tools/.github/workflows/reusable-docs-build.yml@dev + uses: ./.github/workflows/reusable-docs-build.yml with: retain-artifacts: 14 deploy-id: 0 @@ -23,7 +23,7 @@ jobs: docs-verify: name: Verify HTML needs: docs-build - uses: neo4j/docs-tools/.github/workflows/reusable-docs-verify.yml@dev + uses: ./.github/workflows/reusable-docs-verify.yml with: failOnWarnings: true @@ -33,7 +33,7 @@ jobs: steps: - name: Trigger Publish - uses: peter-evans/repository-dispatch@main + uses: peter-evans/repository-dispatch@bf47d102fdb849e755b0b0023ea3e81a44b6f570 # v2.1.2 with: token: ${{ secrets.DISPATCH_TOKEN }} repository: neo4j/docs-publish diff --git a/.github/workflows/docs-published-links.yml b/.github/workflows/docs-published-links.yml index 64ccae3..f56928a 100644 --- a/.github/workflows/docs-published-links.yml +++ b/.github/workflows/docs-published-links.yml @@ -59,7 +59,7 @@ jobs: path: .docs-tools - name: Use Node.js 16 - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: '16' @@ -67,6 +67,6 @@ jobs: # run: npm install github:recrwplay/link-checker#v0.2.0 - name: Run link checker - uses: filiph/linkcheck@3.0.0 + uses: filiph/linkcheck@f2c15a0be0d9c83def5df3edcc0f2d6582845f2d # 3.0.0 with: arguments: $DOCS_PATH/$DOCSET --skip-file $SKIPFILE -e diff --git a/.github/workflows/docs-teardown.yml b/.github/workflows/docs-teardown.yml index 1d93cba..e046595 100644 --- a/.github/workflows/docs-teardown.yml +++ b/.github/workflows/docs-teardown.yml @@ -13,7 +13,7 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/setup-node@v3 + - uses: actions/setup-node@v4 with: node-version: lts/* @@ -36,7 +36,7 @@ jobs: surge teardown $DEPLOY_URL --token "$SURGE_TOKEN" - name: Comment on PR - uses: marocchino/sticky-pull-request-comment@v2 + uses: marocchino/sticky-pull-request-comment@efaaab3fd41a9c3de579aba759d2552635e590fd #v2.8.0 with: number: ${{ github.event.pull_request.number }} header: docs-pr-changes diff --git a/.github/workflows/reusable-docs-build.yml b/.github/workflows/reusable-docs-build.yml index fd7876e..45fb565 100644 --- a/.github/workflows/reusable-docs-build.yml +++ b/.github/workflows/reusable-docs-build.yml @@ -70,7 +70,7 @@ jobs: CLI_OPTIONS: ${{ inputs.cli-options }} steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Checkout tools repo uses: actions/checkout@v4 @@ -82,7 +82,7 @@ jobs: path: .docs-tools - name: Use Node.js 16 - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: '16' @@ -96,14 +96,14 @@ jobs: run: echo $DEPLOY_ID > ./build/deployid - name: Upload HTML artifact - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: docs path: build/ retention-days: ${{ inputs.retain-artifacts }} - name: Upload Log artifact - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: antora-log path: build/log @@ -112,7 +112,7 @@ jobs: - name: Upload Page List artifact id: page-list-artifact if: ${{ inputs.pageList }} - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: page-list path: build/site/.meta/pageList diff --git a/.github/workflows/reusable-docs-links.yml b/.github/workflows/reusable-docs-links.yml index 39a57f3..b5b1360 100644 --- a/.github/workflows/reusable-docs-links.yml +++ b/.github/workflows/reusable-docs-links.yml @@ -50,13 +50,13 @@ jobs: path: .docs-tools - name: Download HTML - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: docs path: build - name: Use Node.js 16 - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: '16' @@ -79,7 +79,7 @@ jobs: # upload artifacts - name: Save log - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: linklog path: link-log.txt diff --git a/.github/workflows/reusable-docs-lint.yml b/.github/workflows/reusable-docs-lint.yml index cfee3a8..f403139 100644 --- a/.github/workflows/reusable-docs-lint.yml +++ b/.github/workflows/reusable-docs-lint.yml @@ -68,13 +68,13 @@ jobs: steps: # Checkout the repo - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 # Fetch the default vale config and styles # Checkout to ./lint - name: download default rules if: ${{ inputs.use-default-rules }} - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: repository: neo4j/docs-tools ref: dev diff --git a/.github/workflows/reusable-docs-pr-changes.yml b/.github/workflows/reusable-docs-pr-changes.yml index 6326341..d1aa336 100644 --- a/.github/workflows/reusable-docs-pr-changes.yml +++ b/.github/workflows/reusable-docs-pr-changes.yml @@ -34,7 +34,7 @@ jobs: - name: Get page list for PR changelog id: get-page-list - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: page-list @@ -116,7 +116,7 @@ jobs: - name: Upload changelog if: ${{ hashFiles('changelog') != '' }} - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: docs path: changelog \ No newline at end of file diff --git a/.github/workflows/reusable-docs-published-links.yml b/.github/workflows/reusable-docs-published-links.yml index 64ccae3..f56928a 100644 --- a/.github/workflows/reusable-docs-published-links.yml +++ b/.github/workflows/reusable-docs-published-links.yml @@ -59,7 +59,7 @@ jobs: path: .docs-tools - name: Use Node.js 16 - uses: actions/setup-node@v3 + uses: actions/setup-node@v4 with: node-version: '16' @@ -67,6 +67,6 @@ jobs: # run: npm install github:recrwplay/link-checker#v0.2.0 - name: Run link checker - uses: filiph/linkcheck@3.0.0 + uses: filiph/linkcheck@f2c15a0be0d9c83def5df3edcc0f2d6582845f2d # 3.0.0 with: arguments: $DOCS_PATH/$DOCSET --skip-file $SKIPFILE -e diff --git a/.github/workflows/reusable-docs-verify.yml b/.github/workflows/reusable-docs-verify.yml index fcb38f0..a311287 100644 --- a/.github/workflows/reusable-docs-verify.yml +++ b/.github/workflows/reusable-docs-verify.yml @@ -19,13 +19,13 @@ jobs: steps: - name: Download Antora log - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: antora-log - name: Analyze Antora log id: antora-log-check-test - uses: recrwplay/antora-log-analyzer@f42057f7215a68108a2863ceecab212470e90cae + uses: recrwplay/antora-log-analyzer@f42057f7215a68108a2863ceecab212470e90cae # 1.0.0 with: fail-on-errors: ${{ inputs.failOnErrors }} fail-on-warnings: ${{ inputs.failOnWarnings }}