Skip to content

Latest commit

 

History

History
176 lines (126 loc) · 5.42 KB

RELEASING.md

File metadata and controls

176 lines (126 loc) · 5.42 KB
Raw
  • Upload py-skygear to PyPI as skygear
  • Docker Hub automatically build skygeario/py-skygear triggered by git push
  • Upload skygear-SDK-iOS to CocoaPods as SKYKit
  • Upload skygear-SDK-JS to npm as skygear
  • Upload skygear-SDK-Android to jcenter

Version number

Version number conforms to x.y.z format. For each release cycle, y is incremented by 1. The same x.y corresponds to the tag of skygear and it will stay the same for all above modules during the release cycle. For hot fix within a release cycle, increment z by 1 and z is reset to 0 on the next release cycle.

How to release?

Preparation

$ export GITHUB_TOKEN=abcdef1234 # Need Repos scope for update release notes
$ export SKYGEAR_VERSION="0.5.0"
$ export KEY_ID="12CDA17C"

$ brew install github-release
$ brew install gpg2

IMPORTANT: This guide assumes that your origin points to skygeario/skygear-server. Make sure you are on master branch and the branch is the same as the origin/master.

skygear-server

## Draft new release changelog
$ git log --first-parent `git describe --abbrev=0`.. > new-release
$ edit new-release

## Update changelog, version.go, release commit and tag
$ make release-commit

### If the release is latest (official release with the highest version number)
$ git tag -f latest && git push git@github.com:SkygearIO/skygear-server.git :latest
$ git push --follow-tags git@github.com:SkygearIO/skygear-server.git master v$SKYGEAR_VERSION latest

## Click `Publish release` in github release page

py-skygear

## Draft new release changelog
$ git log --first-parent `git describe --abbrev=0`.. > new-release
$ edit new-release

## Update changelog, version, release commit and tag
$ make release-commit

### For alpha
## git commit -m "Bump for for $SKYGEAR_VERSION"

### If the release is latest (official release with the highest version number)
$ git tag -f latest && git push git@github.com:SkygearIO/py-skygear.git :latest
$ git push --follow-tags git@github.com:SkygearIO/py-skygear.git master v$SKYGEAR_VERSION latest

## Release to pypi (Only for official release)
$ python3 setup.py sdist upload

## Click `Publish release` in github release page

skygear-SDK-iOS

IMPORTANT: Note that CocoaPods does not allow tag prefixed with v. Therefore the tag name is different from other projects.

IMPORTANT: CocoaPods requires that that tag is pushed to repository before it will accept a new release.

## Draft new release changelog
$ git log --first-parent `git describe --abbrev=0`.. > new-release
$ edit new-release

## Update changelog, version, release commit and tag
$ make release-commit

### If the release is latest (official release with the highest version number)
$ git tag -f latest && git push git@github.com:SkygearIO/skygear-SDK-iOS.git :latest
$ git push --follow-tags git@github.com:SkygearIO/skygear-SDK-iOS.git master $SKYGEAR_VERSION latest

## Push commit to Cocoapods (Only for official release)
$ pod trunk push SKYKit.podspec --allow-warnings

## Click `Publish release` in github release page

skygear-SDK-JS

## Draft new release changelog
$ git log --first-parent `git describe --abbrev=0`.. > new-release
$ edit new-release

## Update changelog, verion, release commit and tag
$ make release-commit

### For alpha
## git commit -m "Bump for for $SKYGEAR_VERSION"

### If the release is latest (official release with the highest version number)
$ git tag -f latest && git push git@github.com:SkygearIO/skygear-SDK-JS.git :latest
$ git push --follow-tags git@github.com:SkygearIO/skygear-SDK-JS.git master v$SKYGEAR_VERSION latest

## Release to npm (Only for official release)
$ npm run lerna exec 'npm publish'
## You will prompt for OTP in each package if you enabled 2FA
## For publishing to alpha channel
$ npm run lerna publish -- --skip-git --npm-tag=alpha --repo-version $SKYGEAR_VERSION

## Click `Publish release` in github release page

skygear-SDK-Android

## Draft new release notes
$ git log --first-parent `git describe --abbrev=0`.. > new-release
$ edit new-release

## Update changelog, version, release commit and tag
$ make release-commit

### If the release is latest (official release with the highest version number)
$ git tag -f latest && git push git@github.com:SkygearIO/skygear-SDK-Android.git :latest
$ git push --follow-tags git@github.com:SkygearIO/skygear-SDK-Android.git master $SKYGEAR_VERSION latest

## Click `Publish release` in github release page

skycli

## Draft new release changelog
$ git log --first-parent `git describe --abbrev=0`.. > new-release
$ edit new-release
$ github-release release -u skygeario -r skycli --draft --tag v$SKYGEAR_VERSION --name "v$SKYGEAR_VERSION" --pre-release --description "`cat new-release`"

## Update changelog
$ cat CHANGELOG.md >> new-release && mv new-release CHANGELOG.md
$ git add CHANGELOG.md
$ git commit -m "Update CHANGELOG for v$SKYGEAR_VERSION"

## Tag and push commit
$ git tag -a v$SKYGEAR_VERSION -s -u $KEY_ID -m "Release v$SKYGEAR_VERSION"
$ git push --follow-tags origin v$SKYGEAR_VERSION
$ git push origin

## Click `Publish release` in github release page

Other notes

To show tag info:

$ git show v0.5.0

To delete tags:

$ git tag -d v$SKYGEAR_VERSION
$ git push origin :refs/tags/v$SKYGEAR_VERSION