8000 docs: update release docs from Fri 13 release session by ckerr · Pull Request #13664 · electron/electron · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

docs: update release docs from Fri 13 release session #13664

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 16, 2018
Merged

docs: update release docs from Fri 13 release session #13664

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
02d072e
fix VSTS token generation URL
ckerr Jul 13, 2018
452b5f3
add note about multiple calls to validateRelease
ckerr Jul 13, 2018
da92abf
document ELECTRON_S3_ tokens
ckerr Jul 13, 2018
3653730
Add post-publish 'npm dist-tag ls electron' step
ckerr Jul 13, 2018
5764d76
Fix formatting
Jul 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 26 additions & 3 deletions docs/development/releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,12 @@ If you don't have an account, ask a team member to add you.
* `CIRCLE_TOKEN`:
Create a token from "Personal API Tokens" at https://circleci.com/account/api
* `VSTS_TOKEN`:
Create a Personal Access Token at https://github.visualstudio.com/_usersSettings/tokens
Create a Personal Access Token at https://github.visualstudio.com/_usersSettings/tokens or https://github.visualstudio.com/_details/security/tokens
with the scope of `Build (read and execute)`.
* `ELECTRON_S3_BUCKET`:
* `ELECTRON_S3_ACCESS_KEY`:
* `ELECTRON_S3_SECRET_KEY`:
If you don't have these, ask a team member to help you.

## Determine which branch to release from

Expand Down Expand Up @@ -65,7 +69,7 @@ npm run prepare-release -- minor
```
### Patch version change
```sh
npm run prepare-release -- patch
npm run prepare-release -- patch --stable
```
### Beta version change
```sh
Expand Down Expand Up @@ -204,6 +208,10 @@ release notes.
```sh
$ npm run release -- --validateRelease
```
Note, if you need to run `--validateRelease` more than once to check the assets,
run it as above the first time, then `node ./script/release.js --validateRelease`
for subsequent calls so that you don't have to rebuild each time you want to
check the assets.

## Publish the release

Expand Down Expand Up @@ -247,6 +255,21 @@ electron
$ npm run publish-to-npm
```

After publishing, you can check the `latest` release:
```sh
$ npm dist-tag ls electron
```

< 8001 /span>
If for some reason `npm run publish-to-npm` fails,
you can tag the release manually:
```sh
$ npm dist-tag add electron@<version> <tag>
```
e.g.:
```sh
$ npm dist-tag add electron@2.0.0 latest
```

[the releases page]: https://github.com/electron/electron/releases
[this bump commit]: https://github.com/electron/electron/commit/78ec1b8f89b3886b856377a1756a51617bc33f5a
[versioning]: /docs/tutorial/electron-versioning.md
Expand Down Expand Up @@ -276,7 +299,7 @@ node script/ci-release-build.js --ci=AppVeyor --ghRelease TARGET_BRANCH
```

Additionally you can pass a job name to the script to run an individual job, eg:
````sh
```sh
node script/ci-release-build.js --ci=AppVeyor --ghRelease --job=electron-x64 TARGET_BRANCH
```

Expand Down
0