You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
none-shall-pass
v1.0.7
none-shall-pass is a GitHub action designed to identify and flag any broken links
within markdown files in your repository and wiki pages.
- In your GitHub repository, select the Actions tab and either add or edit a workflow.
- Search for
none-shall-passfrom the Marketplace tab on the right. - Copy and paste the yaml into your workflow.
Copy & paste the following workflow definition into your project .github/workflows/none-shall-pass.yml
# This workflow checks out code and scans the hyperlinks in
# markdown files for broken links
name: Validate hyperlinks in markdown files
on:
push:
workflow_dispatch:
jobs:
none-shall-pass:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: thevickypedia/[email protected]- Commit your changes to trigger the workflow or run the workflow manually.
Use the options below to configure debug and fail state when broken links are found in the repository/wiki pages.
| option | requirement | description |
|---|---|---|
owner |
optional | Owner/Organization of the repository - Defaults to current owner/org name |
repo |
optional | Name of the repository - Defaults to current repository's name |
fail |
optional | If true (Default) the build is failed if broken links are found.If false the build completes successfully and warnings are provided in the logs |
debug |
optional | If true (Default is false) debug level logging is enabled |
Requirement
python -m pip install gitverseUsage
gitverse-release reverse -f release_notes.rst -t 'Release Notes'Requirement
pip install sphinx==5.1.1 sphinx-rtd-dark-modeUsage
bash pre_commit.sh© Vignesh Rao
Licensed under the MIT License