|
1 | | -name:weekly-docs |
2 | | -# runs every monday at 9 am |
3 | | -on: |
4 | | -schedule: |
5 | | - -cron:"0 9 * * 1" |
6 | | -workflow_dispatch:# allows to run manually for testing |
7 | | -pull_request: |
8 | | -branches: |
9 | | - -main |
10 | | -paths: |
11 | | - -"docs/**" |
| 1 | +#name: weekly-docs |
| 2 | +##runs every monday at 9 am |
| 3 | +#on: |
| 4 | +# schedule: |
| 5 | +# - cron: "0 9 * * 1" |
| 6 | +# workflow_dispatch: # allows to run manually for testing |
| 7 | +# pull_request: |
| 8 | +# branches: |
| 9 | +# - main |
| 10 | +# paths: |
| 11 | +# - "docs/**" |
12 | 12 |
|
13 | | -permissions: |
14 | | -contents:read |
| 13 | +#permissions: |
| 14 | +# contents: read |
15 | 15 |
|
16 | | -jobs: |
17 | | -check-docs: |
18 | | -runs-on:ubuntu-latest |
19 | | -steps: |
20 | | - -name:Harden Runner |
21 | | -uses:step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7# v2.10.1 |
22 | | -with: |
23 | | -egress-policy:audit |
| 16 | +#jobs: |
| 17 | +# check-docs: |
| 18 | +# runs-on: ubuntu-latest |
| 19 | +# steps: |
| 20 | +# - name: Harden Runner |
| 21 | +# uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1 |
| 22 | +# with: |
| 23 | +# egress-policy: audit |
24 | 24 |
|
25 | | - -name:Checkout |
26 | | -uses:actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871# v4.2.1 |
| 25 | +# - name: Checkout |
| 26 | +# uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1 |
27 | 27 |
|
28 | | - -name:Check Markdown links |
29 | | -uses:umbrelladocs/action-linkspector@fc382e19892aca958e189954912fe379a8df270c# v1.2.4 |
30 | | -id:markdown-link-check |
31 | | -# checks all markdown files from /docs including all subfolders |
32 | | -with: |
33 | | -reporter:github-pr-review |
34 | | -config_file:".github/.linkspector.yml" |
35 | | -fail_on_error:"true" |
| 28 | +# - name: Check Markdown links |
| 29 | +# uses: umbrelladocs/action-linkspector@fc382e19892aca958e189954912fe379a8df270c # v1.2.4 |
| 30 | +# id: markdown-link-check |
| 31 | +# # checks all markdown files from /docs including all subfolders |
| 32 | +# with: |
| 33 | +# reporter: github-pr-review |
| 34 | +# config_file: ".github/.linkspector.yml" |
| 35 | +# fail_on_error: "true" |
36 | 36 |
|
37 | | - -name:Send Slack notification |
38 | | -if:failure() && github.event_name == 'schedule' |
39 | | -run:| |
40 | | - curl -X POST -H 'Content-type: application/json' -d '{"msg":"Broken links found in the documentation. Please check the logs at ${{ env.LOGS_URL }}"}' ${{ secrets.DOCS_LINK_SLACK_WEBHOOK }} |
41 | | - echo "Sent Slack notification" |
42 | | -env: |
43 | | -LOGS_URL:https://github.com/coder/coder/actions/runs/${{ github.run_id }} |
| 37 | +# - name: Send Slack notification |
| 38 | +# if: failure() && github.event_name == 'schedule' |
| 39 | +# run: | |
| 40 | +# curl -X POST -H 'Content-type: application/json' -d '{"msg":"Broken links found in the documentation. Please check the logs at ${{ env.LOGS_URL }}"}' ${{ secrets.DOCS_LINK_SLACK_WEBHOOK }} |
| 41 | +# echo "Sent Slack notification" |
| 42 | +# env: |
| 43 | +# LOGS_URL: https://github.com/coder/coder/actions/runs/${{ github.run_id }} |