frostfs-api-go/docs/release-instruction.md
Vitaliy Potyarkin 2bdee4c9e6
All checks were successful
DCO action / DCO (pull_request) Successful in 43s
Tests and linters / Tests with -race (pull_request) Successful in 1m17s
Tests and linters / Tests (pull_request) Successful in 1m24s
Tests and linters / Lint (pull_request) Successful in 1m45s
[#126] Stop using obsolete .github directory
This commit is a part of multi-repo cleanup effort:
TrueCloudLab/frostfs-infra#136

Signed-off-by: Vitaliy Potyarkin <v.potyarkin@yadro.com>
2024-11-06 15:14:57 +03:00

1.4 KiB

Release instructions

Pre-release checks

These should run successfully:

  • go test ./...;
  • golangci-lint run ./...;
  • go fmt ./... (should not change any files);
  • go mog tidy (should not change any files);
  • ./prepare.sh /path/to/frostfs-api/on/your/machine (should not change any files).

Writing changelog

Add an entry to the CHANGELOG.md following the style established there. Add an optional codename(for not patch releases), 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, new features and other changes.

Open Pull Request (must receive at least one approval) and merge this changes.

Update README

Actualize compatibility table in README.md with relevant information.

Tag a release

Use vX.Y.Z tag for releases and vX.Y.Z-rc.N for release candidates following the semantic versioning standard.

Update your local master branch after approved and merged CHANGELOG.md changes. Tag a release (must be signed) and push it:

$ git tag -s vX.Y.Z[-rc.N] && git push origin vX.Y.Z[-rc.N]

Make a proper release

Using git.frostfs.info web interface create a new release based on just created tag with the same changes from changelog and publish it.

Close milestone

Close corresponding vX.Y.Z milestone.