From 654a3a6e6058ba03ab5ba1d8b977fa9ab75df899 Mon Sep 17 00:00:00 2001 From: Pavel Karpy Date: Tue, 31 Aug 2021 16:14:04 +0300 Subject: [PATCH] [#785] docs: Actualize release instructions Signed-off-by: Pavel Karpy --- docs/release-instruction.md | 43 +++++++++++++++++++++---------------- 1 file changed, 24 insertions(+), 19 deletions(-) diff --git a/docs/release-instruction.md b/docs/release-instruction.md index 65eb1521b..ad8c3c7d5 100644 --- a/docs/release-instruction.md +++ b/docs/release-instruction.md @@ -3,10 +3,12 @@ ## Pre-release checks These should run successfully: - * build, - * unit-tests, - * integration tests in - [neofs-devenv](https://github.com/nspcc-dev/neofs-devenv). + * `make all`; + * `make test`; + * `make lint` (should not change any files); + * `make fmts` (should not change any files); + * `go mod tidy` (should not change any files); + * integration tests in [neofs-devenv](https://github.com/nspcc-dev/neofs-devenv). ## Writing changelog @@ -14,7 +16,7 @@ Add an entry to the `CHANGELOG.md` following the style established there. Add an optional codename, version and release date in the heading. Write a paragraph describing the most significant changes done in this release. Add `Fixed`, `Added`, `Removed` and `Updated` sections with fixed bug descriptions -and changes. Describe each change in detail with a reference to github issues if +and changes. Describe each change in detail with a reference to GitHub issues if possible. Update supported version of neofs-contract in `README.md` if there were @@ -26,7 +28,7 @@ Use `vX.Y.Z` tag for releases and `vX.Y.Z-rc.N` for release candidates following the [semantic versioning](https://semver.org/) standard. Tag must be created from the latest commit of the master branch. -## Push changes and release tag to github +## Push changes and release tag to GitHub This step should bypass the default PR mechanism to get a correct result (so that releasing requires admin privileges for the project), both the `master` @@ -34,25 +36,28 @@ branch update and tag must be pushed simultaneously like this: $ git push origin master v0.12.0 -## Prepare and push images to a dockerhub +## Prepare and push images to a Docker Hub -Create images for `neofs-storage`, `neofs-ir` and `neofs-cli` applications -and push them into dockerhub (so that releasing requires privileges in nspccdev -organization in dockerhub) +Create images for `neofs-storage`, `neofs-ir` and `neofs-cli`, `neofs-adm` applications +and push them into Docker Hub (so that releasing requires privileges in nspccdev +organization in Docker Hub) - $ make images - $ docker push nspccdev/neofs-storage:0.12.0 - $ docker push nspccdev/neofs-ir:0.12.0 - $ docker push nspccdev/neofs-cli:0.12.0 + $ make images && make image-storage-testnet + $ docker push nspccdev/neofs-storage:0.24.0 + $ docker push nspccdev/neofs-storage-testnet:0.24.0 + $ docker push nspccdev/neofs-ir:0.24.0 + $ docker push nspccdev/neofs-cli:0.24.0 + $ docker push nspccdev/neofs-adm:0.24.0 -## Make a proper github release +## Make a proper GitHub release -Edit an automatically-created release on github, copy things from changelog. -Make a release. +Edit an automatically-created release on GitHub, copy things from changelog. +Build and tar release binaries with `make prepare-release`, attach them to +the release. Publish the release. -## Close github milestone +## Close GitHub milestone -Close corresponding vX.Y.Z github milestone. +Close corresponding vX.Y.Z GitHub milestone. ## Post-release