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

fix: modify the chglog template to filter commits and correct PRs' URL #170

Merged
merged 3 commits into from
Mar 10, 2022

Conversation

loloicci
Copy link
Contributor

@loloicci loloicci commented Mar 4, 2022

Description

This PR modifies chaglog template to

  • filter commits that are not generated with "squash and merge" merging
  • correct generating URLs for PR from https://.../issues/XXX to https://.../pull/XXX in the suffix of PRs' title

And, modify to print a note to devtools/update_changelog.sh

Closes #164

Types of changes

  • Bug fix (changes which fixes an issue)
  • New feature (changes which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • ETC (build, ci, docs, perf, refactor, style, test)

Checklist

@zemyblue
Copy link
Member

zemyblue commented Mar 8, 2022

@loloicci , can this script distinguish between fixing bugs or adding features and then reflect them in the changes?

loloicci added a commit to Finschia/wasmvm that referenced this pull request Mar 8, 2022
@loloicci
Copy link
Contributor Author

loloicci commented Mar 8, 2022

@zemyblue yes, but not literally. This script decides it is a PR number if the tail of the commit is (#XXX). This is the default subject of the squash and merge commit. Other numbers are still linked as issues.

@zemyblue
Copy link
Member

@zemyblue yes, but not literally. This script decides it is a PR number if the tail of the commit is (#XXX). This is the default subject of the squash and merge commit. Other numbers are still linked as issues.

I meant that this script would automatically generate a change log, but it doesn't seem to distinguish between Features or Fixes or Changes sections. You need to further change the PR section to which section it belongs. Is it right?

@loloicci
Copy link
Contributor Author

@zemyblue In my local, these three types of changes are distinguished. Can you try to remove some recent tags (e.g. v0.16.3-0.5-0 and v0.16.3-0.5.1) and retry to execute update_changelog.sh? If three types of PRs are not distinguished, tell me the output.

@zemyblue
Copy link
Member

Oh, it works well.

But my system is Apple M1 Pro, so I need to change docker run part like below in the generate_chagnelog.sh.
Please check it works well in other system.

MD="docker run --platform linux/x86_64 -v $(pwd):/workdir quay.io/git-chglog/git-chglog"

@loloicci
Copy link
Contributor Author

Oh, it works well.

But my system is Apple M1 Pro, so I need to change docker run part like below in the generate_chagnelog.sh.
Please check it works well in other system.

MD="docker run --platform linux/x86_64 -v $(pwd):/workdir quay.io/git-chglog/git-chglog"

It works in non M1 mac. I deal with it in another issue.

@loloicci loloicci merged commit b61a9e5 into Finschia:main Mar 10, 2022
Expotential108 added a commit to Expotential108/Binding-cosmwasm that referenced this pull request Mar 12, 2023
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.

Fix devtools/update_changelog.sh
4 participants