Destroyed Release Script (markdown)
parent
65f97cbe69
commit
3ee3b0ec4f
1 changed files with 0 additions and 39 deletions
|
@ -1,39 +0,0 @@
|
|||
## Make a new release
|
||||
|
||||
If this is the first time running the release script you'll need to
|
||||
1. [Generate a new personal access token](#generate-a-personal-access-token)
|
||||
1. Create a new virtualenv
|
||||
1. Install these [requirements](https://github.com/lbryio/lbry-app/blob/master/requirements.txt)
|
||||
|
||||
Then, the script can be like:
|
||||
|
||||
`python release.py candidate`
|
||||
|
||||
## What this does
|
||||
|
||||
1. Update each submodule to the most recent commit on the default branch
|
||||
1. Bump the version on each submodule and apply a tag
|
||||
1. Update the changelogs
|
||||
1. Draft releases:
|
||||
1. One on lbry-app/releases for the full app
|
||||
1. One on lbry/releases for just the daemon
|
||||
1. Release notes are auto-populated from the changelogs
|
||||
1. Commit changes and push tags
|
||||
1. Pushing a tag to the lbry-app repo tells the build servers to upload their artifacts to the release
|
||||
|
||||
|
||||
### Generate a Personal Access Token
|
||||
|
||||
The release script creates a draft release and so you need to provide it with a personal access token that has the correct permission. First, go to https://github.com/settings/tokens and click on `Generate new token`
|
||||
|
||||
[[/images/token1.png]]
|
||||
|
||||
Give your token a name, like `lbry-app release` and make sure that `public_repo` is checked.
|
||||
|
||||
[[/images/token2.png]]
|
||||
|
||||
Click Generate Token at the bottom of the page. Save the result somewhere and supply it to the release script when asked. Or, set the environment variable `GH_TOKEN`.
|
||||
|
||||
### Errors
|
||||
|
||||
The release script uses `bumpversion` to take care of modifying the version strings and creating the proper tags. Sometimes this can fail and leave the repo in an incorrect state. When that happens, each submodule will need to be reset back to the right commit and any extra tags need to be deleted. Take a look at https://github.com/lbryio/lbry-app/blob/master/reset.sh as an example.
|
Loading…
Reference in a new issue