Skip to content

Commit

Permalink
ci: speed-up documenation PRs (sovity#926)
Browse files Browse the repository at this point in the history
  • Loading branch information
ununhexium authored May 17, 2024
1 parent 95edac2 commit cdbcf72
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 13 deletions.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ Feel free to edit this release checklist in-progress depending on what tasks nee
- [ ] If the Eclipse EDC version changed, update
the [eclipse-edc-management-api.yaml file](https://github.com/sovity/edc-extensions/blob/main/docs/api/eclipse-edc-management-api.yaml).
- [ ] Update the Postman Collection if required.
- [ ] Run all tests locally as long as the [GH flaky tests](https://github.com/sovity/edc-extensions/issues/870) are a problem.
- [ ] Merge the `release-prep` PR.
- [ ] Wait for the main branch to be green. You can check the status in GH [actions](https://github.com/sovity/edc-extensions/actions).
- [ ] Validate the image
Expand Down
24 changes: 24 additions & 0 deletions .github/workflows/check_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Documentation Checks

on:
push:
branches: [ main ]
release:
types: [ published ]
pull_request:
branches: [ main ]

jobs:
markdown-link-checks:
name: Markdown Link Checks
runs-on: ubuntu-latest
steps:
- uses: FranzDiebold/github-env-vars-action@v2
- uses: actions/checkout@master
- name: "Markdown Link Checker: Generate Config"
run: .github/markdown-link-checker-config.jq > .github/markdown-link-checker-config.json
- name: "Markdown Link Checker: Validate Links"
uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
use-quiet-mode: 'yes'
config-file: '.github/markdown-link-checker-config.json'
18 changes: 5 additions & 13 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ on:
types: [ published ]
pull_request:
branches: [ main ]
paths-ignore:
- '**.md'
- '**.png'
- 'docs/api/**'
- 'LICENSE'

env:
REGISTRY_URL: ghcr.io
Expand Down Expand Up @@ -153,16 +158,3 @@ jobs:
env:
NODE_USER: richardtreier-sovity
NODE_AUTH_TOKEN: ${{ secrets.SOVITY_EDC_CLIENT_NPM_AUTH }}
markdown-link-checks:
name: Markdown Link Checks
runs-on: ubuntu-latest
steps:
- uses: FranzDiebold/github-env-vars-action@v2
- uses: actions/checkout@master
- name: "Markdown Link Checker: Generate Config"
run: .github/markdown-link-checker-config.jq > .github/markdown-link-checker-config.json
- name: "Markdown Link Checker: Validate Links"
uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
use-quiet-mode: 'yes'
config-file: '.github/markdown-link-checker-config.json'

0 comments on commit cdbcf72

Please sign in to comment.