rclone/RELEASE.md

112 lines
3.4 KiB
Markdown
Raw Normal View History

2019-09-02 14:05:29 +02:00
# Release
This file describes how to make the various kinds of releases
## Extra required software for making a release
2015-02-04 23:31:56 +01:00
* [github-release](https://github.com/aktau/github-release) for uploading packages
* pandoc for making the html and man pages
2019-09-02 14:05:29 +02:00
## Making a release
2020-02-01 11:31:42 +01:00
* git checkout master
* git pull
2017-01-02 15:38:14 +01:00
* git status - make sure everything is checked in
2020-02-01 11:31:42 +01:00
* Check GitHub actions build for master is Green
* make test # see integration test server or run locally
2015-02-04 23:31:56 +01:00
* make tag
2020-02-01 11:31:42 +01:00
* edit docs/content/changelog.md # make sure to remove duplicate logs from point releases
2019-10-26 12:04:54 +02:00
* make tidy
* make doc
2017-01-02 16:30:34 +01:00
* git status - to check for new man pages - git add them
2019-04-13 12:01:58 +02:00
* git commit -a -v -m "Version v1.XX.0"
2015-02-04 23:31:56 +01:00
* make retag
* git push --tags origin master
2020-02-01 13:31:44 +01:00
* # Wait for the GitHub builds to complete then...
* make fetch_binaries
* make tarball
* make sign_upload
* make check_sign
2017-07-22 19:16:46 +02:00
* make upload
* make upload_website
* make upload_github
2017-03-18 12:30:04 +01:00
* make startdev
2020-05-27 17:11:47 +02:00
* # announce with forum post, twitter post, patreon post
2016-12-14 18:49:26 +01:00
Early in the next release cycle update the vendored dependencies
2019-09-02 14:05:29 +02:00
* Review any pinned packages in go.mod and remove if possible
2016-12-14 18:49:26 +01:00
* make update
* git status
* git add new files
* git commit -a -v
If `make update` fails with errors like this:
```
# github.com/cpuguy83/go-md2man/md2man
../../../../pkg/mod/github.com/cpuguy83/go-md2man@v1.0.8/md2man/md2man.go:11:16: undefined: blackfriday.EXTENSION_NO_INTRA_EMPHASIS
../../../../pkg/mod/github.com/cpuguy83/go-md2man@v1.0.8/md2man/md2man.go:12:16: undefined: blackfriday.EXTENSION_TABLES
```
Can be fixed with
* GO111MODULE=on go get -u github.com/russross/blackfriday@v1.5.2
* GO111MODULE=on go mod tidy
* GO111MODULE=on go mod vendor
2019-09-02 14:05:29 +02:00
## Making a point release
If rclone needs a point release due to some horrendous bug:
2019-09-02 14:05:29 +02:00
First make the release branch. If this is a second point release then
this will be done already.
2019-09-08 18:35:41 +02:00
* BASE_TAG=v1.XX # eg v1.49
* NEW_TAG=${BASE_TAG}.Y # eg v1.49.1
* echo $BASE_TAG $NEW_TAG # v1.49 v1.49.1
2019-09-02 14:05:29 +02:00
* git branch ${BASE_TAG} ${BASE_TAG}-fixes
Now
* git co ${BASE_TAG}-fixes
* git cherry-pick any fixes
* Test (see above)
2019-09-29 20:47:37 +02:00
* make NEXT_VERSION=${NEW_TAG} tag
* edit docs/content/changelog.md
2019-09-02 14:05:29 +02:00
* make TAG=${NEW_TAG} doc
* git commit -a -v -m "Version ${NEW_TAG}"
2019-09-08 18:35:41 +02:00
* git tag -d ${NEW_TAG}
2019-09-02 14:05:29 +02:00
* git tag -s -m "Version ${NEW_TAG}" ${NEW_TAG}
* git push --tags -u origin ${BASE_TAG}-fixes
2019-09-08 18:35:41 +02:00
* Wait for builds to complete
2019-09-02 14:05:29 +02:00
* make BRANCH_PATH= TAG=${NEW_TAG} fetch_binaries
* make TAG=${NEW_TAG} tarball
* make TAG=${NEW_TAG} sign_upload
* make TAG=${NEW_TAG} check_sign
* make TAG=${NEW_TAG} upload
* make TAG=${NEW_TAG} upload_website
* make TAG=${NEW_TAG} upload_github
* NB this overwrites the current beta so we need to do this
* git co master
2019-11-02 16:24:58 +01:00
* make VERSION=${NEW_TAG} startdev
* # cherry pick the changes to the changelog and VERSION
* git checkout ${BASE_TAG}-fixes VERSION docs/content/changelog.md
* git commit --amend
2019-09-02 14:05:29 +02:00
* git push
* Announce!
## Making a manual build of docker
The rclone docker image should autobuild on docker hub. If it doesn't
or needs to be updated then rebuild like this.
```
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
docker push rclone/rclone:1
docker push rclone/rclone:latest
```