Internal Link Consistency Checker

This actions takes a folder-path and a list of documents as inputs and checks if all the documents contain links to all the files within the folder-path. The primary user for this action is Bevy, a game-engine written in rust, in order to make sure new files added to examples also gets added to the appropriate documentation.

How it works

1. Looks for files recursively within source and collects data about the files (source data).
2. Looks through the documents defined in targets and collects data about the links within them (target data).
3. Cross references source and target data
4. If there are files within source that are not found within all targets, the action will fail. If the action fails, it tries to output helpful messages to guide the user to exactly what needs to be addressed.

Features

• Can look for specific file-types, or all files within folders.
• Can ignore specific folders or files, and will ignore them from both source or targets.
• If a folder is ignored, the action will ignore all files and sub-folders inside it.
• Supports Mardown links and Toml 'path values' (path = "xxx/yyy/zzz")
• Ignores links currently commented out

Example

run-action:
    runs-on: ubuntu-latest
    steps:
        - uses: actions/checkout@v2
        - uses: Weibye/action-internal-link-consistency@1.0.0
            with:
                source: '__tests__/data/source_data/'
                targets: '["__tests__/data/ValidToml.toml", "./__tests__/data/ValidReadme.md"]'
                file-types: '[".test"]'
                exclude-folders: '["__tests__/data/source_data/ignorefolder"]'
                exclude-files: '["__tests__/data/source_data/should_be_ignored.test"]'

Current Limitations

• Only support one source-path, but could be extended / improved if needed. (Covers Bevy's use case)
• Only supports two specific document targets: .md & .toml (Covers Bevy's current use case)

Settings & Configuration

source

Defines the path to the folder that should be scanned for files.

name: source
required: true
default: ''

• Must be parsed to a valid javascript string.
• Should be a valid folder on disk.

targets

List of target documents to parse and cross-reference.

name: targets
required: true
default: '[]'

• Must be parsed to a valid javascript string array.
• Each entry must end with a supported document format. (.md, .toml)

Supported Target Document Formats

For the action to pick up the links within the target documents, they must be defined as following:

1. Markdown Link: [link text](./relative/path/to/file.ext)
2. Toml (path value): path = "./relative/path/to/file.ext"

file-types

Whitelist of file-types to look for.

name: file-types
required: false
default: '[]'

• Must be parsed to a valid javascript string array.
• Extensions must start with . (dot).
• If empty, collects all files within source-path.
• If this contains any entries, the action will only look for those file types.

exclude-folders

List of folders to exclude. This setting make sure any files or folders (recursively) are ignored from consideration and cross check.

name: exclude-folders
required: false
default: '[]'

• Must be parsed to a valid javascript string array.
• Each entry must to be root-relative paths to folders.

exclude-files

List of files to exclude. This setting make sure any file listed here is ignored from consideration and cross check.

name: exclude-files
required: false
default: '[]'

• Must be parsed to a valid javascript string array.
• Each entry must to be root-relative paths to files.