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 and add "release notes" when distributing new builds on Firebase (staging and production) #198

Closed
luongvo opened this issue May 16, 2023 · 2 comments · Fixed by #270
Assignees
Milestone

Comments

@luongvo
Copy link
Member

luongvo commented May 16, 2023

Why

Currently, the template supports existing CD workflows to distribute new builds to Firebase. There is a space for improvement to have release notes on each build to clarify what is being covered with the new update for the PM and testers instead of showing the default release notes.

Solution: available solutions from TPC

  • after merging a PR to develop:

    echo "RELEASE_NOTE_CONTENT="$((git log -1 --merges | grep "\[") | grep . && echo "" || echo $(git log -1 --merges --format=%B))""
    
  • after merging a release PR to main

    echo "RELEASE_NOTE_CONTENT="$(git log --merges --pretty=%B $(git describe --abbrev=0 --tags)..HEAD | grep "\[")""
    

image

Who Benefits?

PM and Testers

@doannimble doannimble self-assigned this Aug 1, 2023
@luongvo luongvo added this to the 1.11.0 milestone Aug 1, 2023
@luongvo
Copy link
Member Author

luongvo commented Aug 9, 2023

@doannimble we can compared with this plugin https://github.com/marketplace/actions/generate-changelog

@manh-t
Copy link
Contributor

manh-t commented Sep 28, 2023

@luongvo @doannimble I just noticed that the merged commit messages differ between GitHub and Bitbucket.
While the commit message in Bitbucket contains the PR title when merging, Github doesn't.
Bitbucket:
image

Github:
image

=> WHen using that command on Bitbucket, I can get [sc-53824] [Integrate] As a user, I can get directions to the store and add it to the release note. The command only works for Bitbucket.

In Github, we cannot get the title of the PR by using the above command, but instead what we get is the last commit message of the PR, like #270 PoW.

In my opinion, if we are unable to obtain the PR title, we should not display the last commit message of the PR. As an alternative solution, we could include the branch name in the release note. For instance, we could present Merge pull request #253 from nimblehq/feature/234-secure-storage in the release note.

The command can become:

# Staging
echo "RELEASE_NOTE_CONTENT="$((git log -1 --merges | grep "pull") | grep . && echo "" || echo $(git log -1 --merges --format=%B))""

#Production
echo "RELEASE_NOTE_CONTENT="$(git log --merges --pretty=%B $(git describe --abbrev=0 --tags)..HEAD | grep "pull")""

Typically, our branch name consists of the ticket ID and ticket title. The PM can rely on this information to determine what will be included in the build. What do you think?

======
EDIT 1: I realize that the other repositories in Github still contain the title of the PR in the merged commit message. I.e android-templates
image

flutter-templates :trollface:
image

After 1.8.0, Github doesn't add the title of the PR to the commit message anymore for us 🤔

doannimble added a commit that referenced this issue Oct 9, 2023
doannimble added a commit that referenced this issue Oct 27, 2023
doannimble added a commit that referenced this issue Oct 27, 2023
doannimble added a commit that referenced this issue Oct 27, 2023
doannimble added a commit that referenced this issue Oct 27, 2023
doannimble added a commit that referenced this issue Oct 27, 2023
doannimble added a commit that referenced this issue Oct 30, 2023
doannimble added a commit that referenced this issue Oct 30, 2023
doannimble added a commit that referenced this issue Oct 31, 2023
@luongvo luongvo modified the milestones: 1.12.0, 1.13.0 Oct 31, 2023
doannimble added a commit that referenced this issue Oct 31, 2023
doannimble added a commit that referenced this issue Oct 31, 2023
doannimble added a commit that referenced this issue Oct 31, 2023
doannimble added a commit that referenced this issue Oct 31, 2023
doannimble added a commit that referenced this issue Oct 31, 2023
doannimble added a commit that referenced this issue Oct 31, 2023
doannimble added a commit that referenced this issue Oct 31, 2023
doannimble added a commit that referenced this issue Nov 3, 2023
doannimble added a commit that referenced this issue Nov 3, 2023
doannimble added a commit that referenced this issue Nov 3, 2023
doannimble added a commit that referenced this issue Nov 3, 2023
doannimble added a commit that referenced this issue Nov 3, 2023
doannimble added a commit that referenced this issue Nov 9, 2023
doannimble added a commit that referenced this issue Nov 9, 2023
doannimble added a commit that referenced this issue Nov 9, 2023
doannimble added a commit that referenced this issue Nov 10, 2023
doannimble added a commit that referenced this issue Nov 10, 2023
luongvo added a commit that referenced this issue Nov 13, 2023
…base-deploy

[#198] Generate and add "release notes" when distributing new builds on Firebase (staging and production)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants