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

Generate changelog to release #723

Merged
merged 4 commits into from
Sep 18, 2024

Conversation

jaroslav-fedor-swi
Copy link
Contributor

@jaroslav-fedor-swi jaroslav-fedor-swi commented Sep 18, 2024

Find all commits in given PATH between two tags, and add it as release notes into release.

  • Excludes merge commits
  • handles changelog differently for alpha/standard releases

Image:

image

data source:

git log "swo-k8s-collector-4.0.0..swo-k8s-collector-4.1.0-alpha.4" --pretty=format:"%s" -- src build  | grep -v Merge
Bump library/golang in /build/docker
NH-90671 Bump base image
Bump distroless/static-debian12 in /build/docker
Bump debian from 12.6 to 12.7 in /build/docker

Helm

image

@jaroslav-fedor-swi jaroslav-fedor-swi requested a review from a team as a code owner September 18, 2024 06:44
@jaroslav-fedor-swi jaroslav-fedor-swi force-pushed the generate-changelog-to-release branch 8 times, most recently from 0434e55 to 0097a22 Compare September 18, 2024 07:01
@jaroslav-fedor-swi jaroslav-fedor-swi marked this pull request as draft September 18, 2024 07:01
@jaroslav-fedor-swi jaroslav-fedor-swi force-pushed the generate-changelog-to-release branch 20 times, most recently from 23a25ea to 89bddc8 Compare September 18, 2024 07:46
@jaroslav-fedor-swi jaroslav-fedor-swi force-pushed the generate-changelog-to-release branch 4 times, most recently from 823cfb0 to f3890a1 Compare September 18, 2024 08:58
@jaroslav-fedor-swi jaroslav-fedor-swi force-pushed the generate-changelog-to-release branch 13 times, most recently from 7b5caba to 773b80d Compare September 18, 2024 09:59
@jaroslav-fedor-swi jaroslav-fedor-swi force-pushed the generate-changelog-to-release branch from 773b80d to 853e34e Compare September 18, 2024 10:00
@jaroslav-fedor-swi jaroslav-fedor-swi marked this pull request as ready for review September 18, 2024 10:01
@@ -56,6 +56,7 @@ jobs:

build_and_test_windows:
runs-on: windows-2022
if: startsWith(github.ref, 'refs/tags/') && !contains(github.ref, 'swo-k8s-collector')
Copy link
Contributor Author

Choose a reason for hiding this comment

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

reverting this to original configuration as it takes ~15mins to run for every commit.

Copy link
Contributor

@gantrior gantrior left a comment

Choose a reason for hiding this comment

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

"Generate release notes" button in GitHub UI still produces a bit better change log as it contains also PR refs and author, like:

but it is good enough

@@ -207,6 +213,9 @@ jobs:
tag_name: ${{ github.ref }} # Use the tag that triggered the workflow
release_name: ${{ github.ref }}
body: |
**Full Changelog**: https://github.com/solarwinds/swi-k8s-opentelemetry-collector/compare/${{ env.PREVIOUS_TAG }}...${{ env.CURRENT_TAG}}
## Changed
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
## Changed
## What's Changed

@jaroslav-fedor-swi
Copy link
Contributor Author

We can add authors, and possibly found PR related to commit, however is that what we want? GH generate button include all changes even not related to the release. It works well if you have single purpose repo.

@jaroslav-fedor-swi jaroslav-fedor-swi merged commit caa525a into master Sep 18, 2024
11 checks passed
@jaroslav-fedor-swi jaroslav-fedor-swi deleted the generate-changelog-to-release branch September 18, 2024 11:45
@jaroslav-fedor-swi jaroslav-fedor-swi added the Skip Changelog Should not be listed in changelog label Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog Should not be listed in changelog
Development

Successfully merging this pull request may close these issues.

2 participants