Utility which helps in managing your workflows, i.e. development process, work process etc.

❗ You are taking a sneak peek at the next version. Please have a look at the README of the git tag in case you are looking for the documentation of the corresponding version. For instance, the README of v0.3.0.

Table of Content

• Scripts
  • TODO Checker
• Usage GitHub Workflow
• Usage GitLab
• Contributors and contribute
• License

Workflow helper is currently featuring the following scripts:

Provides ways to detect unwanted TODOs in files.

Following the output of running todo-checker --help:

Parameters:
-i|--issue-regex     (optional) regex used to match an issue number -- default: #d+
-d|--directory       (optional) specifies which directory (including sub directories) shall be analysed -- default: .
-t|--todo-regex      (optional) regex used to match todos -- default: TODO|FIXME

Examples:
# searches for todos in current directory
# uses default TodoIndicator TODO|FIXME
# uses default IssueIndicator #d+
todo-checker

# searches for todos in directory ./foo with default indicators
todo-checker -d ./foo
todo-checker --directory ./foo

# uses a custom TodoIndicator
todo-checker -t "TODOs?"
todo-checker --todo-regex "TODOs?"

# searches todos for a specific issue by using a custom IssueIndicator
todo-checker -i "#123"
todo-checker --issue-regex "#123"

# searches todos for specific issues by using a custom IssueIndicator
todo-checker -i "#123|op#478"
todo-checker --issue-regex "#123|op#478"

Following an example for the TODO checker script, executing the script twice with different arguments.

.github/workflows/workflow-helper.yml

name: Workflow-helper
on: [push, pull_request]
jobs:
  check:
    runs-on: ubuntu-latest
    steps:           
      - name: Check no todos
        uses: tegonal/workflow-helper@v1
        with:
          commands: 'todo-checker; todo-checker -i "proj#\d+"'

Following an example for the TODO checker script, executing the script twice with different arguments.

.gitlab.yml

check-for-todos:
  image: tegonal/workflow-helper
  stage: check
  script: 
    - todo-checker
    - todo-checker -i "proj#\d+"  

Our thanks go to code contributors as well as all other contributors (e.g. bug reporters, feature request creators etc.)

You are more than welcome to contribute as well:

• star workflow-helper if you like/use it
• open a bug if you find one
• Open a new discussion if you are missing a feature
• ask a question so that we better understand where workflow-helper needs to improve.
• have a look at the help wanted issues if you would like to code.

Workflow helper is licensed under EUPL 1.2.