2019-09-02 20:05:29 +08:00
|
|
|
# Release
|
|
|
|
|
|
|
|
|
|
This file describes how to make the various kinds of releases
|
|
|
|
|
|
|
|
|
|
## Extra required software for making a release
|
|
|
|
|
|
2021-02-05 01:34:30 +08:00
|
|
|
* [gh the github cli](https://github.com/cli/cli) for uploading packages
|
2015-02-05 06:31:56 +08:00
|
|
|
* pandoc for making the html and man pages
|
|
|
|
|
|
2019-09-02 20:05:29 +08:00
|
|
|
## Making a release
|
|
|
|
|
|
2020-09-03 18:29:33 +08:00
|
|
|
* git checkout master # see below for stable branch
|
2020-02-01 18:31:42 +08:00
|
|
|
* git pull
|
2017-01-02 22:38:14 +08:00
|
|
|
* git status - make sure everything is checked in
|
2020-02-01 18:31:42 +08:00
|
|
|
* Check GitHub actions build for master is Green
|
2018-03-17 23:06:04 +08:00
|
|
|
* make test # see integration test server or run locally
|
2015-02-05 06:31:56 +08:00
|
|
|
* make tag
|
2020-02-01 18:31:42 +08:00
|
|
|
* edit docs/content/changelog.md # make sure to remove duplicate logs from point releases
|
2019-10-26 18:04:54 +08:00
|
|
|
* make tidy
|
2016-03-02 01:42:27 +08:00
|
|
|
* make doc
|
2017-01-02 23:30:34 +08:00
|
|
|
* git status - to check for new man pages - git add them
|
2019-04-13 18:01:58 +08:00
|
|
|
* git commit -a -v -m "Version v1.XX.0"
|
2015-02-05 06:31:56 +08:00
|
|
|
* make retag
|
2020-09-13 17:27:24 +08:00
|
|
|
* git push --follow-tags origin
|
2020-02-01 20:31:44 +08:00
|
|
|
* # Wait for the GitHub builds to complete then...
|
2018-09-01 17:19:03 +08:00
|
|
|
* make fetch_binaries
|
2018-03-17 23:06:04 +08:00
|
|
|
* make tarball
|
2020-09-03 00:53:05 +08:00
|
|
|
* make vendorball
|
2018-03-17 23:06:04 +08:00
|
|
|
* make sign_upload
|
|
|
|
|
* make check_sign
|
2017-07-23 01:16:46 +08:00
|
|
|
* make upload
|
|
|
|
|
* make upload_website
|
2015-11-24 05:58:54 +08:00
|
|
|
* make upload_github
|
2020-09-03 18:29:33 +08:00
|
|
|
* make startdev # make startstable for stable branch
|
2020-05-27 23:11:47 +08:00
|
|
|
* # announce with forum post, twitter post, patreon post
|
2016-12-15 01:49:26 +08:00
|
|
|
|
2020-03-04 22:01:25 +08:00
|
|
|
Early in the next release cycle update the dependencies
|
2019-09-02 20:05:29 +08:00
|
|
|
|
2018-09-01 17:19:03 +08:00
|
|
|
* Review any pinned packages in go.mod and remove if possible
|
2016-12-15 01:49:26 +08:00
|
|
|
* make update
|
|
|
|
|
* git status
|
|
|
|
|
* git add new files
|
|
|
|
|
* git commit -a -v
|
2018-09-08 00:10:29 +08:00
|
|
|
|
2019-09-02 20:05:29 +08:00
|
|
|
## Making a point release
|
|
|
|
|
|
2019-09-17 21:22:47 +08:00
|
|
|
If rclone needs a point release due to some horrendous bug:
|
2019-09-02 20:05:29 +08:00
|
|
|
|
2020-09-03 18:29:33 +08:00
|
|
|
Set vars
|
2019-09-02 20:05:29 +08:00
|
|
|
|
2020-10-14 05:49:58 +08:00
|
|
|
* BASE_TAG=v1.XX # e.g. v1.52
|
|
|
|
|
* NEW_TAG=${BASE_TAG}.Y # e.g. v1.52.1
|
2020-06-10 23:49:04 +08:00
|
|
|
* echo $BASE_TAG $NEW_TAG # v1.52 v1.52.1
|
2020-09-03 18:29:33 +08:00
|
|
|
|
|
|
|
|
First make the release branch. If this is a second point release then
|
|
|
|
|
this will be done already.
|
|
|
|
|
|
2020-06-10 23:49:04 +08:00
|
|
|
* git branch ${BASE_TAG} ${BASE_TAG}-stable
|
2020-09-03 18:29:33 +08:00
|
|
|
* git co ${BASE_TAG}-stable
|
|
|
|
|
* make startstable
|
2019-09-02 20:05:29 +08:00
|
|
|
|
|
|
|
|
Now
|
|
|
|
|
|
2020-06-10 23:49:04 +08:00
|
|
|
* git co ${BASE_TAG}-stable
|
2018-09-08 00:10:29 +08:00
|
|
|
* git cherry-pick any fixes
|
2020-09-03 18:29:33 +08:00
|
|
|
* Do the steps as above
|
|
|
|
|
* make startstable
|
2019-09-02 20:05:29 +08:00
|
|
|
* git co master
|
2020-11-25 01:59:52 +08:00
|
|
|
* `#` cherry pick the changes to the changelog - check the diff to make sure it is correct
|
2020-09-03 18:29:33 +08:00
|
|
|
* git checkout ${BASE_TAG}-stable docs/content/changelog.md
|
|
|
|
|
* git commit -a -v -m "Changelog updates from Version ${NEW_TAG}"
|
2019-09-02 20:05:29 +08:00
|
|
|
* git push
|
2019-09-02 21:30:11 +08:00
|
|
|
|
|
|
|
|
## Making a manual build of docker
|
|
|
|
|
|
2020-06-10 23:49:04 +08:00
|
|
|
The rclone docker image should autobuild on via GitHub actions. If it doesn't
|
2019-09-02 21:30:11 +08:00
|
|
|
or needs to be updated then rebuild like this.
|
|
|
|
|
|
|
|
|
|
```
|
2020-06-10 23:51:05 +08:00
|
|
|
docker pull golang
|
2020-05-28 20:12:13 +08:00
|
|
|
docker build --rm --ulimit memlock=67108864 -t rclone/rclone:1.52.0 -t rclone/rclone:1.52 -t rclone/rclone:1 -t rclone/rclone:latest .
|
|
|
|
|
docker push rclone/rclone:1.52.0
|
|
|
|
|
docker push rclone/rclone:1.52
|
2019-09-02 21:30:11 +08:00
|
|
|
docker push rclone/rclone:1
|
|
|
|
|
docker push rclone/rclone:latest
|
|
|
|
|
```
|
