fluvio icon indicating copy to clipboard operation
fluvio copied to clipboard

CHANGELOG CI check

Open tjtelan opened this issue 4 years ago • 3 comments

We need a CI check to enforce updates to CHANGELOG.md when they are appropriate. Our convention for the changelog thus far has been source code changes that are non-test.

I think this check may only be needed for changes within the crates dir that aren't test related? So excluding the fluvio-test-* crates and any changes in a crate that isn't in the src dir, (Needs confirmation)

tjtelan avatar Oct 27 '21 19:10 tjtelan

We could use something like:

https://github.com/rusty-celery/rusty-celery/blob/41efda696132bff7451b191d185a48129ca1b2e3/.github/workflows/ci.yml#L19

morenol avatar Oct 27 '21 19:10 morenol

We could use something like:

https://github.com/rusty-celery/rusty-celery/blob/41efda696132bff7451b191d185a48129ca1b2e3/.github/workflows/ci.yml#L19

This is a step in the direction we want. The way we use our changelog is more fine grained, as we make note of changes that have a public facing impact. The way rusty-celery does it is to enforce a changelog entry to any updates within src/.

Maybe if we can agree that this is an approach we'd like to try for the crates we publish, then this would be an easy-ish task to implement.

tjtelan avatar Nov 12 '21 17:11 tjtelan

Stale issue message

github-actions[bot] avatar Jan 12 '22 11:01 github-actions[bot]