None Shall Pass

none-shall-pass is a GitHub action designed to identify and flag any broken links within markdown files in your repository and wiki pages.

Install Guide

Add none-shall-pass action to your build workflow

• In your GitHub repository, select the Actions tab and either add or edit a workflow.
• Search for none-shall-pass from the Marketplace tab on the right.
• Copy and paste the yaml into your workflow.

[OR]

Copy & paste the following workflow definition into your project .github/workflows/none-shall-pass.yml

name: Validate hyperlinks in markdown files

on:
  push:
  workflow_dispatch:

jobs:
  none-shall-pass:
    runs-on: ubuntu-latest  # Can run on multiple operating systems
    steps:
      - uses: thevickypedia/none-shall-pass@v5

• Commit your changes to trigger the workflow or run the workflow manually.

Action configuration options

Use the options below to configure debug and fail state when broken links are found in the repository/wiki pages.

• debug - If true debug level logging is enabled. Defaults to false
• owner - Owner/Organization of the repository. Defaults to current owner/org name
• repo - Name of the repository. Defaults to current repository's name
• excludeHostnames - Space separated list of hostnames to ignore when failed. Defaults to ""
• failOnError - If true (Default is false) the action will fail if broken links are found. Defaults to false

excludeHostnames will perform a regex like lookup, so wildcards (*) are not required

To exclude any URL with amazon/amzn in it simply specify,
excludeHostnames: "amazon amzn"

Release Notes

Requirement

python -m pip install gitverse

Usage

gitverse-release reverse -f release_notes.rst -t 'Release Notes'

Docs

Requirement

pip install sphinx==5.1.1 sphinx-rtd-theme recommonmark requests

Usage

bash pre_commit.sh

License & copyright

© Vignesh Rao

Licensed under the MIT License