Skip to content

commit message check - footer references.

Summary

Add a user toggled setting that enforces issue or merge request references.

The check to output JUnit test report with the commit hash as the class name and the error message as part of the class. The test name could be called commit footer references. The link from the JUnit report should be directly to the docs and explains how to fix.

Workflow

not master or development branch:

  1. variable enabled create validation job

  2. variable is False, do nothing

  3. variable is not defined, create validation job.

is master or development branch:

  1. Do nothing.

intent is only to run on branches that a user is going to create their own commit messages and of a type that will be added to the changelog.

Links

👷 Tasks

  • checks for footer references

  • if #3 (closed) is enabled

    • add a validation job to confirm commit messages have a footer with references.
    • ignores commit type style build
  • outputs junit test report

    • links to docs on how to fix
  • JUnit report brakes down each commit to a single test

  • if enabled enforce dependency of commit check job to the changelog job

  • docs updated

  • only validates commits from branch start to branch HEAD

Edited by Jon
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information