github.com/TrueCloudLab/frostfs-api-go/v2@v2.0.0-20230228134343-196241c4e79a/docs/release-instruction.md (about)

     1  # Release instructions
     2  
     3  ## Pre-release checks
     4  
     5  These should run successfully:
     6  * `go test ./...`;
     7  * `golangci-lint run ./...`;
     8  * `go fmt ./...` (should not change any files);
     9  * `go mog tidy` (should not change any files);
    10  * `./prepare.sh /path/to/frostfs-api/on/your/machine` (should not change any files).
    11  
    12  ## Writing changelog
    13  
    14  Add an entry to the `CHANGELOG.md` following the style established there. Add an
    15  optional codename(for not patch releases), version and release date in the heading.
    16  Write a paragraph describing the most significant changes done in this release. Add
    17  `Fixed`, `Added`, `Removed` and `Updated` sections with fixed bug, new features and
    18  other changes.
    19  
    20  Open Pull Request (must receive at least one approval) and merge this changes.
    21  
    22  ## Update README
    23  
    24  Actualize compatibility table in `README.md` with relevant information.
    25  
    26  ## Tag a release
    27  
    28  Use `vX.Y.Z` tag for releases and `vX.Y.Z-rc.N` for release candidates
    29  following the [semantic versioning](https://semver.org/) standard.
    30  
    31  Update your local `master` branch after approved and merged `CHANGELOG.md` changes.
    32  Tag a release (must be signed) and push it:
    33  
    34  ```
    35  $ git tag -s vX.Y.Z[-rc.N] && git push origin vX.Y.Z[-rc.N]
    36  ```
    37  
    38  ## Make a Github release
    39  
    40  Using Github's web interface create a new release based on just created tag
    41  with the same changes from changelog and publish it.
    42  
    43  ## Close github milestone
    44  
    45  Close corresponding vX.Y.Z github milestone.