Checks the code base for any terms ending with a colon, and fail/pass the check if
any are found depending on severity. The default term is FIXME:. You can add or change the terms
using the term parameter, see Installation below.
Useful if you want to make sure that you don't miss any required changes in the
code base before merging a PR. The default severity is ERROR. If severity is set to
ERROR if any terms are found the ci fails. If set to WARNING it passes but you
will still have annotations.
It runs very fast, taking only a few seconds to finish even on a very large
codebase. All files in the repository will be read, including binary files (it
uses git grep under the hood).
In your checks list and PR, you get helpful annotations like this:
Edit or create a workflow .yml file in .github/workflows folder of your repository.
Here's an example of a linters.yml workflow.
name: Linters
on: [push]
jobs:
fixmes:
name: FIXME annotate
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: rippleFCL/action-fixme-annotate@v0.1.0 # or @ the latest release
with:
terms: 'WIP|FIXME' # optional, defaults to `FIXME`
case-sensitive: false # optional, defaults to `true`
severity: "WARNING" # optinal, defaults to `ERROR`(Used for testing this action on itself.)
- I am using
WIP:here. - I am using
FIXME:here. - Nothing to see here.
- I am using
FIX:here. - I am using
wip:here. - I am using
fixme:here.
The action-fixme-check library is available as open source under the terms of
the MIT License. This license means you
can use it however you want, as long as you give me credit. Praise and adoration
is optional, but encouraged.