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

Jump to bottom

Adding 'go' as the release type makes changes to 'CHANGES.md' instead of CHANGELOG.md #924

Closed
atreya2011 opened this issue Jun 5, 2021 · 9 comments · Fixed by #986
Closed

Adding 'go' as the release type makes changes to 'CHANGES.md' instead of CHANGELOG.md #924

atreya2011 opened this issue Jun 5, 2021 · 9 comments · Fixed by #986
Assignees
@bcoe
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.

Comments

@atreya2011
Copy link

atreya2011 commented Jun 5, 2021 •
edited
Loading

#890

I noticed a recent pull request adds a generic go release type and the documentation is not up to date to reflect the same.
@atreya2011 atreya2011 mentioned this issue Jun 5, 2021
Closed
4 tasks
@yoshi-automation yoshi-automation added the triage me I really want to be triaged. label Jun 6, 2021
@atreya2011
Copy link
Author

atreya2011 commented Jun 7, 2021 •
edited
Loading

It also seems like the go release-type creates CHANGES.md instead of updating an existing CHANGELOG.md.

Is there any way to override this behaviour?

It seems like setting the changelog-path in the release-please-action does not seem to override this behaviour...

I am NOT able to override this behavior even after setting up the release-please bot with the following release-please.yml

releaseType: go
handleGHRelease: true
changelogPath: CHANGELOG.md

@sofisl sofisl changed the title Add 'go' to release types list in README.md Adding 'go' as the release type makes changes to 'CHANGES.md' instead of CHANGELOG.md Jun 7, 2021
@sofisl sofisl added priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Jun 7, 2021
@bcoe bcoe removed the triage me I really want to be triaged. label Jun 7, 2021
@bcoe
Copy link
Contributor

bcoe commented Jun 7, 2021

@codyoss is it common for go to use CHANGES.md rather than CHANGELOG.md? or was this design decision specific to how we were doing things on our team?

@codyoss
Copy link
Member

codyoss commented Jun 8, 2021 •
edited
Loading

@bcoe CHANGES was a pre-existing pattern that our teams Go libraries had used. I think in general CHANGELOG is more prevalent, but even then I don't actually see most projects use them as they seem to just favor using Github releases.

@bcoe
Copy link
Contributor

bcoe commented Jun 8, 2021

@codyoss I think we use go-yoshi everywhere for our internal stuff now? wondering if we could make the go releaser use CHANGELOG, and address @atreya2011's hiccup.

@codyoss
Copy link
Member

codyoss commented Jun 8, 2021

@codyoss Yup, we are fully migrated. That sounds good to me!

@abemedia
Copy link
Contributor

Any update on this? Would be great if the changelogPath option actually worked but even just changing the go releaser to CHANGELOG.md would already be good!

bcoe added a commit to googleapis/release-please-action that referenced this issue Jul 28, 2021
@bcoe
fix: support alternate CHANGELOG.md path
3ebcfd6 
Refs: googleapis/release-please#924
bcoe added a commit that referenced this issue Jul 28, 2021
@bcoe
feat(go): default to CHANGELOG.md
f5b3b49 
Fixes #924
This was referenced Jul 28, 2021
Merged
Merged
@bcoe bcoe closed this as completed in #986 Jul 28, 2021
bcoe added a commit that referenced this issue Jul 28, 2021
@bcoe
feat(go): default to CHANGELOG.md (#986)
5ab2069 
Fixes #924
gcf-merge-on-green bot pushed a commit that referenced this issue Jul 28, 2021
@release-please
chore: release 11.18.0 (#987)
0cbfd47 
🤖 I have created a release \*beep\* \*boop\*
---
## [11.18.0](https://www.github.com/googleapis/release-please/compare/v11.17.0...v11.18.0) (2021-07-28)


### Features

* **go:** default to CHANGELOG.md ([#986](https://www.github.com/googleapis/release-please/issues/986)) ([5ab2069](https://www.github.com/googleapis/release-please/commit/5ab2069c22f3b5d5aba9dbd34f061a4de871e07c)), closes [#924](https://www.github.com/googleapis/release-please/issues/924)
---


This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
bcoe added a commit to googleapis/release-please-action that referenced this issue Jul 28, 2021
@bcoe
fix: support alternate CHANGELOG.md path (#329)
3e6dc1e 
Refs: googleapis/release-please#924
@bcoe
Copy link
Contributor

bcoe commented Jul 28, 2021

@abemedia @atreya2011 this should be working now 👍 sorry it took a little while to get to.

@abemedia
Copy link
Contributor

Awesome, thanks!

@atreya2011
Copy link
Author

Thank you 🙏🏼

@hbollon hbollon mentioned this issue Aug 2, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bcoe bcoe

Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(go): default to CHANGELOG.md googleapis/release-please
docs: add 'go' to release types list
7 participants
@bcoe @abemedia @codyoss @atreya2011 @yoshi-automation @sofisl and others