docs: update release and publishing #529

TarikGul · 2021-04-29T17:26:32Z

This PR aims to update the documentation around releasing a new release of sidecar.

closes: #527

emostov

Thanks, looks good; just a few suggestions. (Hopefully we will have a more automated release process in the near future)

README.md

Co-authored-by: Zeke Mostov <32168567+emostov@users.noreply.github.com>

dvdplm · 2021-04-30T07:18:10Z

@maciejhirsz PTAL
@niklasad1 same for you; I believe there's a release to be made on Monday so make sure these instructions work for you.

README.md

niklasad1 · 2021-04-30T08:16:46Z

README.md

+
+4. Update the version in the package.json (this is very important for releasing on NPM).
+
+5. Update `CHANGELOG.md` by looking at merged PRs since the last release. Follow the format of previous releases. 


do we got a script to get all PRs in the CHANGELOG or how's that performed?

Currently we do not, we update it manually unfortunately. Earlier on with sidecar there was an issue with standard-version which started to cause inaccuracies with changelog automation. This is something we still need to fix, and probably should make priority soon.

The solution we had was to deprecate the current changelog and start a new one. We are tracking that issue here.

Fortunately though, because we release every week, there isn't a lot of PR's to actually track and log. Usually just the updated dep's, and one or two PR's.

Co-authored-by: Niklas Adolfsson <niklasadolfsson1@gmail.com>

maciejhirsz

LGTM

dvdplm

I think we need a Notion page where we keep a "internal use" checklist of people and organizations to notify for new releases (and in particular who to call when there's a fire).

dvdplm · 2021-05-04T08:42:09Z

README.md

@@ -270,30 +270,65 @@ Need help or want to contribute ideas or code? Head over to our [CONTRIBUTING](C

 ## Note for maintainers

+* Commits && Releases && Publishing


What's up with the double ampersand?

dvdplm · 2021-05-04T08:43:02Z

README.md

+  * @polkadot/apps-config [release notes](https://github.com/polkadot-js/apps/releases)
+  * @polkadot/util-crypto [release notes](https://github.com/polkadot-js/common/releases)
+
+  Note: Every monday the polkadot-js ecosystem will usually come out with a new release. It's important that we keep up, and read the release notes for any breaking changes, or high priority updates.


Would be good to mention where to look for these updates.

dvdplm · 2021-05-04T08:45:29Z

README.md

+
+5. Update `CHANGELOG.md` by looking at merged PRs since the last release. Follow the format of previous releases. 
+
+  * Make sure to note if it is a high upgrade priority (e.g. it has type definitions for an upcoming runtime upgrade to a Parity maintained network).


It would be good to keep a checklist of who to notify when we release high priority stuff (likely on to be kept on Notion, but a mention here is good also).

dvdplm · 2021-05-04T08:46:46Z

README.md

+
+  * Make sure to note if it is a high upgrade priority (e.g. it has type definitions for an upcoming runtime upgrade to a Parity maintained network).
+
+6. Commit with ex: `chore(release): 5.0.1`, then push your release up, make a PR, get review approval, then merge. 


What does "push your release" mean? Do you mean the name-vx.y.z branch?

dvdplm · 2021-05-04T08:47:39Z

README.md

-ℹ Run `git push --follow-tags origin master && npm publish` to publish
+### Step 1 - Preparation
+
+1. Checkout a branch `name-v5-0-1`. When deciding what version will be released it is important to look over 1) PRs since the last release and 2) release notes for any updated polkadot-js dependencies as they may affect type definitions.


s/name-v5-0-1/name-vMM-mm-pp

dvdplm · 2021-05-04T08:48:17Z

README.md

+
+6. Commit with ex: `chore(release): 5.0.1`, then push your release up, make a PR, get review approval, then merge. 
+
+  * NOTE: Before pushing up as a sanity check run the 3 following commands and ensure they all run with zero errors. There is one exception with `yarn test` where you will see an `InternalServerError`, that is alright. As long as all the test suites pass. 


s/alright/expected/

dvdplm · 2021-05-04T08:50:02Z

README.md

+1. Make sure the tag reflects your corresponding version, and run:
+
+```bash
+git tag -s v5.0.1


s/v5.0.1/vMM.mm.pp/ where MM is the major, mm the minor and pp the patch release.

dvdplm · 2021-05-04T08:50:26Z

README.md

+git push origin v5.0.1
+```
+
+2. Go to tags on github, inside of the repo, and click the three dots to the far right and select the option to create a release. 


Add a link directly?

TarikGul · 2021-05-05T03:35:51Z

@dvdplm I like the following suggestions, i think they are practical/useful. I'll put together a small issue to get a PR for these. I also like the idea of putting this all in the notion page for any future cases.

TarikGul added 3 commits April 29, 2021 13:18

docs(release): update release notes

d80285e

docs(release): update release notes

996950b

docs(release): update release notes

9ec2269

TarikGul requested review from dvdplm, maciejhirsz, insipx, niklasad1 and emostov April 29, 2021 17:26

emostov approved these changes Apr 29, 2021

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Show resolved Hide resolved

TarikGul and others added 5 commits April 29, 2021 14:01

Update README.md

05e0eef

Co-authored-by: Zeke Mostov <32168567+emostov@users.noreply.github.com>

Update README.md

1c60903

Co-authored-by: Zeke Mostov <32168567+emostov@users.noreply.github.com>

Update README.md

642dfa7

Co-authored-by: Zeke Mostov <32168567+emostov@users.noreply.github.com>

Update README.md

f4f86c6

Co-authored-by: Zeke Mostov <32168567+emostov@users.noreply.github.com>

Update README.md

8e605a5

Co-authored-by: Zeke Mostov <32168567+emostov@users.noreply.github.com>

niklasad1 reviewed Apr 30, 2021

View reviewed changes

README.md Outdated Show resolved Hide resolved

niklasad1 reviewed Apr 30, 2021

View reviewed changes

Update README.md

c998781

Co-authored-by: Niklas Adolfsson <niklasadolfsson1@gmail.com>

maciejhirsz approved these changes Apr 30, 2021

View reviewed changes

niklasad1 approved these changes Apr 30, 2021

View reviewed changes

TarikGul merged commit da33c7f into master Apr 30, 2021

TarikGul deleted the tarik-updates-release-docs branch April 30, 2021 12:53

dvdplm reviewed May 4, 2021

View reviewed changes

This was referenced May 5, 2021

[docs]: update release and publishing #534

Closed

build: Improve release build & process instructions #540

Merged

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: update release and publishing #529

docs: update release and publishing #529

TarikGul commented Apr 29, 2021 •

edited

Loading

emostov left a comment •

edited

Loading

dvdplm commented Apr 30, 2021

niklasad1 Apr 30, 2021

TarikGul Apr 30, 2021

TarikGul Apr 30, 2021

maciejhirsz left a comment

dvdplm left a comment

dvdplm May 4, 2021

dvdplm May 4, 2021

dvdplm May 4, 2021

dvdplm May 4, 2021

dvdplm May 4, 2021

dvdplm May 4, 2021

dvdplm May 4, 2021

dvdplm May 4, 2021

TarikGul commented May 5, 2021


		4. Update the version in the package.json (this is very important for releasing on NPM).

		5. Update `CHANGELOG.md` by looking at merged PRs since the last release. Follow the format of previous releases.

		@@ -270,30 +270,65 @@ Need help or want to contribute ideas or code? Head over to our [CONTRIBUTING](C

		## Note for maintainers

		* Commits && Releases && Publishing


		5. Update `CHANGELOG.md` by looking at merged PRs since the last release. Follow the format of previous releases.

		* Make sure to note if it is a high upgrade priority (e.g. it has type definitions for an upcoming runtime upgrade to a Parity maintained network).


		* Make sure to note if it is a high upgrade priority (e.g. it has type definitions for an upcoming runtime upgrade to a Parity maintained network).

		6. Commit with ex: `chore(release): 5.0.1`, then push your release up, make a PR, get review approval, then merge.


		6. Commit with ex: `chore(release): 5.0.1`, then push your release up, make a PR, get review approval, then merge.

		* NOTE: Before pushing up as a sanity check run the 3 following commands and ensure they all run with zero errors. There is one exception with `yarn test` where you will see an `InternalServerError`, that is alright. As long as all the test suites pass.

docs: update release and publishing #529

docs: update release and publishing #529

Conversation

TarikGul commented Apr 29, 2021 • edited Loading

emostov left a comment • edited Loading

Choose a reason for hiding this comment

dvdplm commented Apr 30, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maciejhirsz left a comment

Choose a reason for hiding this comment

dvdplm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TarikGul commented May 5, 2021

TarikGul commented Apr 29, 2021 •

edited

Loading

emostov left a comment •

edited

Loading