Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add git cliff toml to support generation of changelog #2697

Merged
merged 19 commits into from
Nov 15, 2022
Merged

Add git cliff toml to support generation of changelog #2697

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
670d534
feat: adding git cliff toml
chatton Sep 8, 2022
d8cafd4
chore: using docker image to generate changelog
chatton Nov 7, 2022
4b53323
Merge branch 'main' into git-cliff-2106
chatton Nov 7, 2022
16ee689
chore: adding usage information in cliff.toml
chatton Nov 7, 2022
6706aed
Merge branch 'main' into git-cliff-2106
chatton Nov 8, 2022
3b6c79d
Merge branch 'main' into git-cliff-2106
chatton Nov 8, 2022
87c12dd
Merge branch 'main' into git-cliff-2106
chatton Nov 8, 2022
a875571
Merge branch 'main' into git-cliff-2106
chatton Nov 9, 2022
1813f59
Merge branch 'main' into git-cliff-2106
chatton Nov 11, 2022
4569ff0
chore: implemnted regex change suggestions
chatton Nov 11, 2022
aabaed7
chore: updating CONTRIBUTING.md with details about commit messages
chatton Nov 11, 2022
8490b30
Merge branch 'main' into git-cliff-2106
chatton Nov 14, 2022
2353229
Update CONTRIBUTING.md
chatton Nov 14, 2022
140d251
Merge branch 'main' into git-cliff-2106
chatton Nov 14, 2022
d90488e
chore: addressing PR feedback and updating pull request template
chatton Nov 14, 2022
13403c9
Merge branch 'main' into git-cliff-2106
chatton Nov 14, 2022
0c028ac
Merge branch 'main' into git-cliff-2106
chatton Nov 15, 2022
3ba101c
chore: adding support for processing each individual line of the comm…
chatton Nov 15, 2022
0a30c21
Merge branch 'main' into git-cliff-2106
chatton Nov 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 29 additions & 6 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,41 @@ are the most critical to review.

closes: #XXXX


### Commit Message / Changelog entry
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc @colin-axner @charleenfei @damiannolan @crodriguezvega

I updated the PR template to include a new section where contributors will include the proposed commit message / changelog entry. (can thumbs up if you're happy, and leave a comment if you have any suggestions / concerns! )


```bash
type: commit message
```

see the [guidelines](../CONTRIBUTING.md#commit-messages) for commit messages. (view raw markdown for examples)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe move this into the comment section?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this was intended to be short version with a prompt to look at the raw markdown (it might not be obvious if you don't know where to look).

Do you think it's not necessary to indicate that there is more details in comments?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was just thinking this would show on every pr description, but it is only relevant to the pr opener and thus it might make sense to make it a comment in the description so it isn't viewable by the reviewers. But I have no preference, we can always change it later

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it might provide some value, but like you said we can always remove it in the future if it just ends up being perceived as bloat!



<!--
Example commit messages:

fix: skip emission of unpopulated memo field in ics20
deps: updating sdk to v0.46.4
chore: removed unused variables
e2e: adding e2e upgrade test for ibc-go/v6
docs: ics27 v6 documentation updates
feat: add semantic version utilities for e2e tests
feat(api)!: this is an api breaking feature
fix(statemachine)!: this is a statemachine breaking fix
-->

---

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

- [ ] Targeted PR against correct branch (see [CONTRIBUTING.md](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#pr-targeting))
- [ ] Targeted PR against correct branch (see [CONTRIBUTING.md](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#pr-targeting)).
- [ ] Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
- [ ] Code follows the [module structure standards](https://github.com/cosmos/cosmos-sdk/blob/main/docs/docs/building-modules/10-structure.md).
- [ ] Wrote unit and integration [tests](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#testing)
- [ ] Updated relevant documentation (`docs/`) or specification (`x/<module>/spec/`)
- [ ] Wrote unit and integration [tests](https://github.com/cosmos/ibc-go/blob/master/CONTRIBUTING.md#testing).
- [ ] Updated relevant documentation (`docs/`) or specification (`x/<module>/spec/`).
- [ ] Added relevant `godoc` [comments](https://blog.golang.org/godoc-documenting-go-code).
- [ ] Added a relevant changelog entry to the `Unreleased` section in `CHANGELOG.md`
- [ ] Re-reviewed `Files changed` in the Github PR explorer
- [ ] Review `Codecov Report` in the comment section below once CI passes
- [ ] Provide a [commit message](../CONTRIBUTING.md#commit-messages) to be used for the changelog entry in the PR description for review.
- [ ] Re-reviewed `Files changed` in the Github PR explorer.
- [ ] Review `Codecov Report` in the comment section below once CI passes.
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Types of changes (Stanzas):
"Bug Fixes" for any bug fixes.
"Client Breaking" for breaking CLI commands and REST routes used by end-users.
"API Breaking" for breaking exported APIs used by developers building on SDK.
"State Machine Breaking" for any changes that result in a different AppState given same genesisState and txList.
"State Machine Breaking" for any changes that result in a different AppState given the same genesisState and txList.
Ref: https://keepachangelog.com/en/1.0.0/
-->

Expand Down
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,8 @@ All PRs require an approval from at least one CODEOWNER before merge. PRs which

Commit messages should be [conventional](https://www.conventionalcommits.org/en/v1.0.0/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do all the commits in the PR need to follow this convention or the one that matters is the commit message that is entered when squashing the PR? Because in that case, we can have more relaxed rules for the commits while you're working on the PR, and then be careful when squashing the PR, which is something that we have control of.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes you're right it's only the final squashed commit that matters.


If opening a PR, include the proposed commit message in the PR description.

The commit message type should be one of:

* `feat` / `feature` for feature work.
Expand All @@ -100,10 +102,12 @@ The commit message type should be one of:
* `deps` / `build` for changes to dependencies.
* `chore` / `misc` / `nit` for any miscellaneous changes that don't fit into another category.

**Note**: If any change breaking, the following format must be used:
**Note**: If any change is breaking, the following format must be used:
* `type` + `(api)!` for api breaking changes, e.g. `fix(api)!: api breaking fix`
colin-axner marked this conversation as resolved.
Show resolved Hide resolved
* `type` + `(statemachine)!` for state machine breaking changes, e.g. `fix(statemachine)!: state machine breaking fix`
colin-axner marked this conversation as resolved.
Show resolved Hide resolved

**`api` breaking changes take precedence over `statemachine` breaking changes.**

### Updating Documentation

If you open a PR on ibc-go, it is mandatory to update the relevant documentation in /docs.
Expand Down
2 changes: 1 addition & 1 deletion cliff.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Types of changes (Stanzas):
"Deprecated" for soon-to-be removed features.
"Bug Fixes" for any bug fixes. (bug, fix)
"API Breaking" for breaking exported APIs used by developers building on SDK. Add (api)! e.g. fix(api)!: api breaking fix
"State Machine Breaking" for any changes that result in a different AppState given same genesisState and txList. Add (statemachine)! e.g. fix(statemachine)!: state machine breaking fix
"State Machine Breaking" for any changes that result in a different AppState given the same genesisState and txList. Add (statemachine)! e.g. fix(statemachine)!: state machine breaking fix
Ref: https://keepachangelog.com/en/1.0.0/
-->

Expand Down