commitizen-action-pr's Introduction

commitizen-action-pr

Add commitizen incredibly fast into your project!

Features

Check Pr title

Are you using conventional commits and semver?

Then you are ready to use this github action, the only thing you'll need is the .cz.toml file in your project.

Usage

In your repository create a .cz.toml file (you can run cz init to create it)
Create a .github/workflows/bumpversion.yaml with the Sample Workflow

Minimal configuration

Your .cz.toml (or pyproject.toml if you are using python) should look like this.

[tool.commitizen]
version = "0.1.0"  # This should be your current semver version

For more information visit commitizen's configuration page

Sample Workflow

name: Pull request validation

on:
  pull_request:
        types: ['opened', 'edited', 'reopened', 'synchronize']

jobs:
  bump_version:
    if: "!startsWith(github.event.head_commit.message, 'bump:')"
    runs-on: ubuntu-latest
    name: "Bump version and create changelog with commitizen"
    steps:
      - name: Check out
        uses: actions/checkout@v2
        with:
          fetch-depth: 0
          token: "${{ secrets.GITHUB_TOKEN }}"
      - name: Validate PR title with commitizen
        uses: CashStory/[email protected]

Troubleshooting

I'm not using conventional commits, I'm using my own set of rules on commits

If your rules can be parsed then you can build your own commitizen rules, you can create a new commitizen python package or you can describe it on the toml conf itself.

Contributors

Watchers

commitizen-action-pr's Issues

Permissions issue within `entrypoint.sh`

Github secret doesn't seem to have permissions to access the github event path.

Running the action results in this error right after it finishes pip installing everything:

/entrypoint.sh: line 19: /github/workflow/event.json: Permission denied
Traceback (most recent call last):
  File "<string>", line 1, in <module>
  File "/usr/local/lib/python3.8/json/__init__.py", line 293, in load
    return loads(fp.read(),
  File "/usr/local/lib/python3.8/json/__init__.py", line 357, in loads
    return _default_decoder.decode(s)
  File "/usr/local/lib/python3.8/json/decoder.py", line 337, in decode
    obj, end = self.raw_decode(s, idx=_w(s, 0).end())
  File "/usr/local/lib/python3.8/json/decoder.py", line 355, in raw_decode
    raise JSONDecodeError("Expecting value", s, err.value) from None
json.decoder.JSONDecodeError: Expecting value: line 1 column 1 (char 0)

Have you seen this error before?

Recommend Projects