Skip to content

dev: add release:prep script #2952

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

Merged
merged 5 commits into from
Mar 25, 2021
Merged

Conversation

jsjoeio
Copy link
Contributor

@jsjoeio jsjoeio commented Mar 23, 2021

This PR adds a new script called release:prep to help with the release process by asking for the new version and then automating the following steps:

  • Update in package.json
  • Update in ./docs/install.md
  • Update in ./ci/helm-chart/README.md
  • Remember to update the chart version as well on top of appVersion in Chart.yaml.
  • Update all values mentioning the version
  • Update the code coverage badge (see here for instructions)
  • Update the docs badge in ./README.md

Demo

Screen.Recording.2021-03-23.at.11.41.06.AM.mov

TODOS

  • check if dry_run works with CMD="echo"
  • fix DRY_RUN initialized at top
  • refactor git check branch and push upstream
  • fix git add mistake

@jsjoeio jsjoeio added this to the v3.9.2 milestone Mar 23, 2021
@jsjoeio jsjoeio self-assigned this Mar 23, 2021
@jsjoeio jsjoeio requested a review from a team March 23, 2021 18:49
@jsjoeio jsjoeio marked this pull request as ready for review March 23, 2021 18:49
@jsjoeio jsjoeio force-pushed the jsjoeio/add-release-prep-script branch from 5a0a96f to 191cbe3 Compare March 23, 2021 19:03
@jsjoeio jsjoeio changed the title dev(release): add release:prep script dev: add release:prep script Mar 23, 2021
Copy link

@oxy oxy left a comment

Choose a reason for hiding this comment

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

In line 36 of the script, you're checking for hub but towards the end of the script, you're using gh - they're not the same tool!

fi

# Check that hub is installed
if ! command -v hub &>/dev/null; then
Copy link

Choose a reason for hiding this comment

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

check for gh instead of hub here

Copy link
Contributor Author

@jsjoeio jsjoeio Mar 24, 2021

Choose a reason for hiding this comment

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

they're not the same tool!

I may be a noob at writing scripts but I'm not THAT much of a noob.
I know they're not the same tool 😂 That's intentional!

gh is hub's successor, hence why I'm using it here. Eventually, the plan is to remove the use of hub and only use gh but now, the maintainer releasing should have both because it's used here and here.

I'll make a follow-up issue to remove the use of hub and replace with gh.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link

Choose a reason for hiding this comment

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

Do we check for gh elsewhere? I'm not too sure >.<

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think in the update-vscode script too since it's used there.

Copy link
Member

@code-asher code-asher left a comment

Choose a reason for hiding this comment

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

Awesome to see this automated!

@jsjoeio jsjoeio force-pushed the jsjoeio/add-release-prep-script branch from 7f786f4 to a94589d Compare March 24, 2021 23:44
@jsjoeio jsjoeio requested review from oxy and code-asher March 24, 2021 23:44
@jsjoeio jsjoeio force-pushed the jsjoeio/add-release-prep-script branch from a94589d to 42eb7c4 Compare March 25, 2021 00:51
Copy link

@oxy oxy left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Member

@code-asher code-asher left a comment

Choose a reason for hiding this comment

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

🚀

@jsjoeio jsjoeio force-pushed the jsjoeio/add-release-prep-script branch from 42eb7c4 to 299e17e Compare March 25, 2021 16:47
@repo-ranger repo-ranger bot merged commit 004c608 into main Mar 25, 2021
@repo-ranger repo-ranger bot deleted the jsjoeio/add-release-prep-script branch March 25, 2021 17:31
@jsjoeio jsjoeio added the chore Related to maintenance or clean up label May 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Related to maintenance or clean up
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants