Cocogitto diya - github action

Note

This is a fork of original Cocogitto github action. Created to speed up development of new features.

diya (дія) is a literal translation of word action into Ukrainian language.

This action uses cocogitto to check your repository is conventional commit and perform auto-release.

Once the action's step is finished cocogitto binary will be available in PATH.

Requirement

1. Before running this action you need to call checkout action with fetch-depth: 0. This is mandatory, otherwise not all commit will be fetched and cocogitto will fail to execute (see actions/checkout for more info).
2. Cocogitto assumes you are running on a x86 linux runner.

Checking commits

on: [push]

jobs:
  cog_check_job:
    runs-on: ubuntu-latest
    name: check conventional commit compliance
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Conventional commit check
        uses: eshepelyuk/cocogitto-diya@v1

If you are running your workflow on: [pull_request], additional setup for actions/checkout is needed to checkout the right commit:

on: [pull_request]

jobs:
  cog_check_job:
    runs-on: ubuntu-latest
    name: check conventional commit compliance
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
          # pick the pr HEAD instead of the merge commit
          ref: ${{ github.event.pull_request.head.sha }}

      - name: Conventional commit check
        uses: eshepelyuk/cocogitto-diya@v1

If you are familiar with cocogitto this will run cog check and nothing else.

Check commits since latest tag

In some case you might want to perform check only since the latest tagged version. If your repository has not always been conventional commits compliant, then you probably want to use this option.

- name: Conventional commit check
  uses: eshepelyuk/cocogitto-diya@v1
  with:
    check-latest-tag-only: true

Let us assume the following git history :

* 9b609bc - (HEAD -> main) WIP: feat unfinished work
* d832ca4 - feat: working on feature A
* d5ce110 - (tag: 0.1.0) chore: release 0.1.0
* 8f25a4b - chore: a commit before tag 0.1.0

Using check-latest-tag-only: true here would make cocogitto check for the two commits made since tag 0.1.0, the action would fail on HEAD which contains the non-conventional commit type 'WIP'.

In case there's no existing tags, the action will fall back to cog check.

Performing release

You can also use this action to perform releases (calling cog bump --auto under the hood) (see: cocogitto's auto bump).

Action generates release changelog file, putting file name into step's output.

- name: Semver release
  uses: eshepelyuk/cocogitto-diya@v1
  id: release
  with:
    release: true
    git-user: 'Cog Bot'
    git-user-email: '[email protected]'

  # The version number is accessible as the step's output.
  # Also output contains `bumped` flag, indicating if version was bumped or not.
- name: Publish GitHub release, if version changed
  if: ${{ steps.release.outputs.bumped }}
  uses: softprops/action-gh-release@v2
  with:
    body_path: ${{ steps.release.outputs.changelog }}
    tag_name: ${{ steps.release.outputs.version }}

Note that you probably want to set the git-user and git-user-email options to override the default the git signature for the release commit. If you are not familiar with how cocogitto perform release, you might want to read the auto bump and hook sections on cocogitto's documentation.

Inputs reference

Here are all the inputs available through with:

Input	Description	Default
check	Check conventional commit compliance with cog check.	true
check-latest-tag-only	Check conventional commit compliance with cog check --from-latest-tag.	false
release	Perform a release using cog bump --auto.	false
git-user	Set the git user.name to use for the release commit.	cog-bot
git-user-email	Set the git user.email to use for the release commit.	[email protected]
working-directory	Set working directory.	.
release-initial-version	Initial version for the first release.	""