Skip to content

Commit

Permalink
common: update RELEASE_STEPS.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
osalyk committed Jul 26, 2023
1 parent 242fec6 commit 48bca30
Showing 1 changed file with 21 additions and 11 deletions.
32 changes: 21 additions & 11 deletions doc/RELEASE_STEPS.md → RELEASE_STEPS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This document contains all the steps required to make a new release of PMDK.

After following steps 1-3 you should have 2 local commits. The first one is a new, tagged version
of the PMDK repository. The second commit is required to restore a "default" state of the repository
(for more details, on why this is required, please see section ["For curious readers"](#7-for-curious-readers)).
(for more details, on why this is required, please see section ["For curious readers"](#8-for-curious-readers)).

As a helper you can export these 2 variables in your bash - with proper version set:

Expand Down Expand Up @@ -60,21 +60,25 @@ Steps to make a package:
- gpg --armor --detach-sign pmdk-$VERSION.tar.gz

## 3. Undo temporary release changes

- git cherry-pick a6e1bc12c544612b1bba2f7c719765a13ca64926 # a hash commit containing generic undo, called "common: git versions"
- git rm VERSION
- git commit --reset-author

## 4. Publish changes
- for major/minor release:
- git push upstream HEAD:master $VERSION
- create and push stable-$VER branch:

```bash
# push the tag
git push upstream $VERSION
# create and push a stable branch
git checkout -b stable-$VER
git push upstream stable-$VER
git push origin stable-$VER
```
- for major/minor release:
- create stable-$VER branch on upstream repository
- create PR to the new stable-$VER branch
- for patch release:
- git push upstream HEAD:stable-$VER $VERSION
- create PR from stable-$VER to the next stable branch (or to master, if the release is from the last stable branch)
- create PR to proper stable branch

## 5. Publish package and make it official

Expand All @@ -83,15 +87,21 @@ Steps to make a package:
- release title: PMDK Version $VERSION,
- description: copy entry from the ChangeLog
- upload prepared package (pmdk-$VERSION.tar.gz) and its detached signature (pmdk-$VERSION.tar.gz.asc) as an attachment
- announce the release on the pmem group, Slack, and any other channels (if needed)
- this step is not recommended for rc versions
## 6. Later, for major/minor release
## 6. Announcement (only major/minor releases)
Announce the release on the:
- [pmem.io](https://pmem.io/announcements/)
- [Slack](pmem-io.slack.com)
- [Google group](https://groups.google.com/g/pmem )
## 7. Later, for major/minor release
- on the stable-$VER branch, bump the version of Docker images (`utils/docker/images/set-images-version.sh`) to $VER
- once the pmem.github.io repository contains new documentation (thanks to `utils/docker/run-doc-update.sh` script run in CI),
add a new tag ("$VER") in file `data/releases_linux.yml` based on previous tags in this file.
## 7. For curious readers
## 8. For curious readers
### PMDK version
To understand why we need step 3. from the above instruction we'd have to understand how we establish
Expand Down

0 comments on commit 48bca30

Please sign in to comment.