-
Notifications
You must be signed in to change notification settings - Fork 51
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4104 from zowe/user/markackert/dead-link-checker
Dead Link Checker
- Loading branch information
1 parent
ad00d51
commit 2aad2fb
Showing
3 changed files
with
65 additions
and
4 deletions.
There are no files selected for viewing
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,12 @@ | ||
| # This lychee configuration tries to find dead links in zwe, pswi, and smpe files which may be displayed to the user. | ||
| # This does not focus on dead links for internal-facing documentation, e.g. README.md. | ||
|
|
||
| # We're including language sources as well as document files since the language sources embed URLs | ||
| # which can be displayed to the user, e.g. 'zwe' shell script commands displaying help information. | ||
|
|
||
| exclude_path = ['smpe/bld/service/_README_sample_sysmod_builds.docx'] | ||
| # This exclude list covers known urls which should be ignored, including ones which contained | ||
| # templated values in typescript. The templates are covered by a wildcard. | ||
| exclude = [ 'https://www.eclipse.org/legal/epl-v20.html', 'https://zowe.org/schemas/*', 'https://www.zowe.org/schemas/*', 'https://discovery', 'https://github.com/zowe/launcher/blob/*', 'https://myregistry/url$', 'https://your-zos-host-name/zosmf/*{1,60}', '^http://service.software.ibm.com/holdata/390holddata.html', ] | ||
|
|
||
| hidden = true |
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,49 @@ | ||
| # This link checker focuses on covering end-user facing links, not developer documentation. | ||
| # This means we cover the smp/e, pswi, and zwe content. | ||
| # The lychee toml files are set to ignore links which popped up in comments or variables. | ||
| permissions: read-all | ||
|
|
||
| name: Link Check CI | ||
|
|
||
| on: | ||
| pull_request: | ||
| types: [opened, synchronize] | ||
| push: | ||
| branches: | ||
| - 'v3.x/staging' | ||
| - 'v2.x/staging' | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| lychee-link-check: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | ||
|
|
||
| - name: Link Checker | ||
| id: lychee | ||
| uses: lycheeverse/lychee-action@f81112d0d2814ded911bd23e3beaa9dda9093915 # v2.1.0 | ||
| with: | ||
| fail: true | ||
| format: json | ||
| output: lychee_output.json | ||
| args: --config ./.github/lychee.toml --no-progress --verbose --max-retries 10 'bin/**/*' 'smpe/**/*' 'workflows/**/*' | ||
|
|
||
| - name: Output failed links in console | ||
| id: quick-output | ||
| if: always() | ||
| run: | | ||
| if [[ -f "lychee_output.json" ]]; then | ||
| jq .fail_map lychee_output.json | ||
| else | ||
| echo "lychee command failed and didn't produce output" | ||
| fi | ||
| - name: Publish Output | ||
| id: publish | ||
| if: always() | ||
| uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 | ||
| with: | ||
| name: lychee_results.json | ||
| path: lychee_output.json |
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