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

GitHub Action

FIXME alert

v1.0.0

FIXME alert

list

FIXME alert

Check code for specific terms (FIXME, WIP, etc.) and fail (with code annotations) if any are found

Installation

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

              

- name: FIXME alert

uses: bbugh/action-fixme-check@v1.0.0

Learn more about this action in bbugh/action-fixme-check

Choose a version

action-fixme-alert

Checks the code base for any FIXME: (with the colon) and fails the check if any are found. Useful if you want to make sure that you don't miss any required changes in the code base before merging a PR.

This uses the built-in git grep command, and the built-in action problem matchers, so it's very fast. It only takes a few seconds to run, even on a very large codebase.

Installation

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 check
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1
    - uses: bbugh/action-fixme-check@master # or @ the latest release

Support

License

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.