Skip to content

Latest commit

 

History

History
89 lines (57 loc) · 1.71 KB

README.md

File metadata and controls

89 lines (57 loc) · 1.71 KB
Raw

No fixmes check for GitHub Actions

Check that there are no fixmes in the code base.

Description

A reusable github action that can be utilised by other repositories to check that there are no fixmes in the code base.

Usage

Basic

- name: Check for no fixme's 
  id: fixme-check
  uses: climatepolicyradar/gha-no-fixmes@v0

Specify full version

- name: Check for no fixme's 
  id: fixme-check
  uses: climatepolicyradar/[email protected]

Developer Guide

Requirements

Update documents

Update usage automatically in README.md.

make docs

Release

1. Bump up to a new version

Run the following command to bump up.

make bump

This command will execute the following steps:

  1. Update VERSION
  2. Update README.md
  3. Commit and push
  4. Create a pull request
  5. Open the web browser automatically for reviewing pull request

Then review and merge, so the release is ready to go.

2. Create a new GitHub Release

Run the following command to create a new release.

make release

This command will execute the following steps:

  1. Push tag
  2. Create a new GitHub Release as a draft
  3. Open the web browser automatically for editing GitHub Release

3. Publish actions in GitHub Marketplace

Edit to publicize the GitHub Release.

  1. Click the edit icon on the right side of the page
  2. Edit the release notes
  3. Click Publish release

Then, the new version are published in GitHub Marketplace. Finally, we can use the new version! 🎉

License

Apache 2 Licensed. See LICENSE for full details.