search

hashicorp / go-changelog

Changelog generation based on files in a directory.
Mozilla Public License 2.0
107 stars 20 forks source link

Investigate Required Changelog File/Entry Workflow #8

Open bflad opened 3 years ago

bflad commented 3 years ago

Description

Certain projects may want an easy GitHub Actions workflow to require changelog entries for pull requests that are managed by go-changelog. Currently, this can be done, but requires some glue scripting, such as what is done by Consul.

It would be great if projects could quickly configure a workflow to enable this behavior. This could be potentially done along with other changelog checks as shown below:

- uses: hashicorp/go-changelog-check
  with:
    pull-request-number: {{ github.event.pull_request.number }}
    required: true
    required-ignore-labels: ["pr/no-changelog"]

References

paddycarver commented 3 years ago

changelog-pr-body-check may be able to serve as the basis for this, too.

bflad commented 3 years ago

For sure! The thinking here is having the actual GitHub Action side of things make this very simple for implementations and the underlying implementation can be whatever.