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

The release note generated by action-gh-release includes older changes than the selected version #4777

Open
ffjlabo opened this issue Feb 7, 2024 · 4 comments
Open

The release note generated by action-gh-release includes older changes than the selected version #4777

ffjlabo opened this issue Feb 7, 2024 · 4 comments
Assignees
@t-kikuc
Labels
area/tool good first issue Good for newcomers kind/bug Something isn't working size/L

Comments

@ffjlabo
Copy link
Member

ffjlabo commented Feb 7, 2024

What happened:

When I use action-gh-release, some older changes exist.

For example, I released v0.46.0 from v0.45.4. I expected the release note to include changes from v0.45.4 to HEAD commit, but there were some changes created at older than v0.45.4.

#4775 (comment)

Release_v0_46_0_by_ffjlabo_·_Pull_Request__4775_·_pipe-cd_pipecd

Maybe it looks like changes from v0.45.0 to HEAD commit because the last one is the next to the merged commit for v0.45.0.
https://github.com/pipe-cd/pipecd/commits/master/?after=49627aa0e3dcd29c30d3f251813ac36f077ebb25+104

Commits_·_pipe-cd_pipecd

What you expected to happen:

We hope to include the correct changes like from v0.45.4 to v0.46.0.

How to reproduce it:

Environment:

  • piped version:
  • control-plane version:
  • Others:
@ffjlabo ffjlabo added kind/bug Something isn't working good first issue Good for newcomers area/tool labels Feb 7, 2024
@t-kikuc t-kikuc self-assigned this Sep 26, 2024
@t-kikuc
Copy link
Member

t-kikuc commented Sep 26, 2024

let me try 🤾

@t-kikuc t-kikuc added this to ROADMAP Oct 4, 2024
@t-kikuc t-kikuc moved this to 🤔 In voting in ROADMAP Oct 4, 2024
@ffjlabo ffjlabo added this to v0.50.0 Oct 23, 2024
@t-kikuc
Copy link
Member

t-kikuc commented Nov 10, 2024

Investigation Result

The cause

The list contains from v0.N.0, which is the common ancestor of release-v0.N.x and master.
(e.g. v0.49.0...c0392f596b8e50b05cf896a8b1707d70614120c7 for v0.49.3)

  • The tool lists commits of <previous-tag>...<head> in the master branch.
    (e.g. v0.49.2...c0392f596b8e50b05cf896a8b1707d70614120c7 for v0.49.3 release)

    pipecd/tool/actions-gh-release/release.go

    Lines 172 to 173 in c2bf91d

    revisions := fmt.Sprintf("%s...%s", baseCfg.Tag, event.HeadCommit)
    commits, err := listCommits(ctx, gitExecPath, repoDir, revisions)

  • Patch release tags are put to release-v0.N.x, not master,

Why not happened previously?

Previously, this problem did not exist because the release flow was different.
The feature of automatically creating a Release was turned off in #3701 (The reason is not sure...).
At that time, the release flow of release-v0.N.x did not exist.

Solution (not full answer)

  • We need to change the release flow. The tool should list commits in release-v0.N.z AFTER cherry-picking.
  • Listing commits in master branch is NOT enough because it contains several commits which would not be released as patch (e.g. pipedv1-related).

@t-kikuc
Copy link
Member

t-kikuc commented Nov 11, 2024

This problem does not happen when releasing minor versions.
The reason is the same as I mentioned above.

@t-kikuc
Copy link
Member

t-kikuc commented Nov 22, 2024

Let me postpone this issue. The reasons are:

  1. Prioritize developing the plugin
  2. We need to change the release flow after releasing the plugin arch

@t-kikuc t-kikuc moved this from 🤔 In voting to 🌮 Postponed in ROADMAP Nov 22, 2024
@t-kikuc t-kikuc removed this from v0.50.0 Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@t-kikuc t-kikuc

Labels
area/tool good first issue Good for newcomers kind/bug Something isn't working size/L
Projects
ROADMAP
Status: 🌮 Postponed
Milestone
No milestone
Development

No branches or pull requests
3 participants
@khanhtc1202 @ffjlabo @t-kikuc