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.

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

Replace outdated changelog #332

Merged
merged 1 commit into from
Dec 15, 2020
Merged

Replace outdated changelog #332

merged 1 commit into from
Dec 15, 2020

Conversation

alpe
Copy link
Contributor

@alpe alpe commented Dec 4, 2020

@alpe alpe requested a review from ethanfrey December 4, 2020 12:54
@codecov
Copy link

codecov bot commented Dec 4, 2020

Codecov Report

Merging #332 (3e5de6d) into master (095453d) will increase coverage by 0.04%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #332      +/-   ##
==========================================
+ Coverage   69.68%   69.73%   +0.04%     
==========================================
  Files          28       28              
  Lines        2421     2415       -6     
==========================================
- Hits         1687     1684       -3     
+ Misses        616      613       -3     
  Partials      118      118              
Impacted Files Coverage Δ
x/wasm/internal/types/codec.go 44.00% <0.00%> (-1.17%) ⬇️

Copy link
Member

@ethanfrey ethanfrey left a comment

Choose a reason for hiding this comment

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

Lgtm for auto gen.

Two comments:

  1. We need to be extra careful with the names of issues or prs, so the title makes sense without more context.
  2. Some items (eg closed issues as "will not do") should not appear here. Maybe you can generate the log with the tool, and then do a bit of hand sanitizing, to remove noise.

@alpe
Copy link
Contributor Author

alpe commented Dec 8, 2020

Agree that we should be more sensible with titles. Hand sanitizing would not work as it always generates the full changelog and not only the diff to the last commit. But with a better use of labels we can have this covered as well:

Automatically exclude specific issues that are irrelevant to your changelog (by default, any issue labeled question, duplicate, invalid, or wontfix) ✂️

https://github.com/github-changelog-generator/github-changelog-generator#features-and-advantages-of-this-project

There is one behaviour that we need to consider in the workflow: the v0.13.0 section can only be generated when the tag was set. In order to have a proper changelog, we need to generate it at the latest before we tag, then set the tag and generate again after the tag. The PR to close an issue will not contain the changelog for it.... 🤔
Nevertheless with a generator we will not miss an issue anymore and also we can be more calm on merge conflicts. Any mistake would be fixed with the next run....

@alpe alpe changed the title Generated changelog Replace outdated changelog with fully generated one Dec 8, 2020
@alpe
Copy link
Contributor Author

alpe commented Dec 8, 2020

I have gone through the closed issues without a PR and assigned exclusion labels before regenerating.

@ethanfrey
Copy link
Member

Thank you for the explanation and it sounds good.

There is one behaviour that we need to consider in the workflow: the v0.13.0 section can only be generated when the tag was set. In order to have a proper changelog, we need to generate it at the latest before we tag, then set the tag and generate again after the tag. The PR to close an issue will not contain the changelog for it.... 🤔

Looks like we need some time traveling circular dependencies here. 👍

What about.

  • prepare 0.13 pr
  • locally tag v0.13.0 (do not push tag)
  • generate changelog, commit and push
  • merge pr
  • pull latest master, git tag -f v0.13.0 and push that tag

@alpe
Copy link
Contributor Author

alpe commented Dec 8, 2020

🤔 the generated doc seems not to be deterministic. I got a different file for every run now on the same codebase.
I will have another look for a generator.

@alpe
Copy link
Contributor Author

alpe commented Dec 11, 2020

It worked better with an docker image: docker run -it --rm -v "$(pwd)":/usr/local/src/your-app ferrarimarco/github-changelog-generator --USER=CosmWasm --Project=wasmd --TOKEN=

@alpe
Copy link
Contributor Author

alpe commented Dec 14, 2020

Cropped everything before v0.12.0

I think some best practice to use labels for better semantic makes sense. But as discussed on internal discord, I would go with a manual changelog in the future and use the generator before a release to collect the data and double check.

@alpe alpe requested a review from ethanfrey December 14, 2020 13:06
@alpe alpe changed the title Replace outdated changelog with fully generated one Replace outdated changelog Dec 15, 2020
@alpe alpe merged commit c73a039 into master Dec 15, 2020
@alpe alpe deleted the changelog_331 branch December 15, 2020 07:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Restart changelog
2 participants