diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml index 644f277f..65547608 100644 --- a/.github/workflows/links.yml +++ b/.github/workflows/links.yml @@ -20,29 +20,28 @@ jobs: linkChecker: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Find all markdown files id: find_files - run: echo "MD_FILES=$(find . -name '*.md' -type f | sed 's|^./||' | tr '\n' ' ')" >> $GITHUB_ENV - + run: echo "MD_FILES=$(find . -name '*.md' -type f -not -path '*/docs/release_notes*' | sed 's|^./||' | tr '\n' ' ')" >> $GITHUB_ENV + - name: Link Checker id: lychee - uses: lycheeverse/lychee-action@v1.2.0 + uses: lycheeverse/lychee-action@v1.4.1 + env: + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} with: - #format: json - args: --verbose --no-progress ${{ env.MD_FILES }} --github-token ${{secrets.GITHUB_TOKEN}} --exclude https://s3.* - https://files.* https://demo.* ^\w*#.* http(s)?://example.com.* (https://clear.ml)(/)?(blog|pricing|docs)(/)?(latest/docs/index.html)? - (https://app)(.community.clear.ml|.app.clear.ml)?(/)?(dashboard|profile|projects.*)? - http://localhost.* `http.+` https://.{10,}\.git https://api.* http://[0-9].* - https://allegroai.jfrog.io/clearml/api/pypi/public/simple mailto:clearml@allegro.ai - https://allegroai.github.io/clearml-helm-charts https://gist.github.com https://twitter.com/clearmlapp - + # Fail action on broken links + fail: true + # Use json as output format (instead of markdown) + # format: json + args: ${{ env.MD_FILES }} --max-concurrency 1 --no-progress --verbose #- name: Read Results # if: ${{ steps.lychee.outputs.exit_code != 0 }} # run: echo "FAILED_URLS=$(jq -r '.fail_map[] | .[] | .url' ./lychee/out.md)" >> $GITHUB_ENV - + #- name: Slack Notification # if: ${{ steps.lychee.outputs.exit_code != 0 }} # uses: tokorom/action-slack-incoming-webhook@main @@ -51,6 +50,6 @@ jobs: # with: # blocks: | # [ - # {"type": "section", "text": {"type": "mrkdwn", "text": ":warning: Link Checker failure in github.com/allegroai/clearl-docs "}}, + # {"type": "section", "text": {"type": "mrkdwn", "text": ":warning: Link Checker failure in github.com/allegroai/clearml-docs "}}, # {"type": "section", "text": {"type": "mrkdwn", "text": "$FAILED_URLS"}} # ] diff --git a/.lycheeignore b/.lycheeignore new file mode 100644 index 00000000..0dba0a85 --- /dev/null +++ b/.lycheeignore @@ -0,0 +1,25 @@ +s3://.* +gs://.* +https://files.* +https://demo.* +^\w*#.* +http(s)?://example.com.* +(https://clear.ml)(/)?(blog|pricing|docs)(/)?(latest/docs/index.html)? +(https://app)(.community.clear.ml|.app.clear.ml)?(/)?(dashboard|profile|projects.*)? +http://localhost.* +http://127.* +`http.+` +https://.{10,}\.git +https://api.* +http://[0-9].* +https://allegroai.jfrog.io/clearml/api/pypi/public/simple +mailto:clearml@allegro.ai +https://allegroai.github.io/clearml-helm-charts +https://gist.github.com +https://twitter.com/clearmlapp +http[s]?://s3\.amazonaws\.com.* +http[s]?://github\.com/.*/issues/.* +http[s]?://github\.com/.*/pull/.* +file:///github/.* +http[s]?://.*\.linkedin\.com/.* +\$\(uname diff --git a/docs/release_notes/ver_1_3.md b/docs/release_notes/ver_1_3.md index e102d0ce..40cf9bd6 100644 --- a/docs/release_notes/ver_1_3.md +++ b/docs/release_notes/ver_1_3.md @@ -14,7 +14,7 @@ title: Version 1.3 * Add support for setting reported values for `NaN` and `Inf` [ClearML GitHub issue #604](https://github.com/allegroai/clearml/issues/604) * Add reserved OS environments warning * Add git credentials to colab example [ClearML GitHub PR #621](https://github.com/allegroai/clearml/pull/621) -* Add jsonargparse support [ClearML GitHub issue #403](https://github.com/allegroai/clearml/issue/403) +* Add jsonargparse support [ClearML GitHub issue #403](https://github.com/allegroai/clearml/issues/403) * Update autokeras example **Bug Fixes**