Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
check-square

GitHub Action

none-shall-pass

v2.0

none-shall-pass

check-square

none-shall-pass

Run validations against hyperlinks in all markdown files (including Wiki pages)

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: none-shall-pass

              
  uses: thevickypedia/[email protected]
Learn more about this action in thevickypedia/none-shall-pass

Choose a version

made-with-gha

pages

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.

marketplace

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.

Action configuration options

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
excludeHostnames optional Comma separated list of hostnames to ignore when failed

excludeHostnames will perform a regex like lookup, so wildcards (*) are not required and spaces don't matter

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

Usage

bash pre_commit.sh

License & copyright

© Vignesh Rao

Licensed under the MIT License