Skip to content

Commit

Permalink
chore(documentation): Update release flow in collaborator guide md (#…
Browse files Browse the repository at this point in the history 
…8166)

* chore(documentation): Update release flow in collaborator guide md

* update doc based on review feedback

* use capital letter for Video.js

---------

Co-authored-by: Dzianis Dashkevich <[email protected]>
  • Loading branch information
@dzianis-dashkevich
dzianis-dashkevich and Dzianis Dashkevich authored Mar 1, 2023
1 parent 852493d commit 2e939e2
Showing 1 changed file with 20 additions and 33 deletions.
53 changes: 20 additions & 33 deletions COLLABORATOR_GUIDE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,9 @@
* [I accidentally pushed a broken commit or incorrect commit to main](#i-accidentally-pushed-a-broken-commit-or-incorrect-commit-to-main)
* [I lost changes](#i-lost-changes)
* [I accidentally committed a broken change to main](#i-accidentally-committed-a-broken-change-to-main)
* [video.js releases](#videojs-releases)
* [Video.js releases](#videojs-releases)
* [Getting dependencies](#getting-dependencies)
* [npm access](#npm-access)
* [GitHub personal access token](#github-personal-access-token)
* [Deciding what type of version release](#deciding-what-type-of-version-release)
* [Doing a release](#doing-a-release)
* [Current Video.js](#current-videojs)
Expand All @@ -29,7 +28,7 @@

## Issues and Pull Requests

Full courtesy should always be shown in video.js projects.
Full courtesy should always be shown in Video.js projects.

Collaborators may manage issues they feel qualified to handle, being mindful of our guidelines.

Expand All @@ -55,7 +54,7 @@ There are labels that are useful to include on issues and PRs. A few of them are

## Accepting changes

Any code change in video.js should be happening through Pull Requests on GitHub. This includes core committers.
Any code change in Video.js should be happening through Pull Requests on GitHub. This includes core committers.

Before a PR is merged, it must be reviewed by at least two core committers, at least one if it comes from a core committer.

Expand Down Expand Up @@ -280,16 +279,18 @@ To do so, just reset the branch against main.
git reset --hard upstream/main
```
## video.js releases
## Video.js releases
Releasing video.js is partially automated through various scripts.
To do a release, you need a couple of things: npm access, GitHub personal access token.
Releasing Video.js is partially automated through various scripts.
To do a release, all you need is just write access to the repo!
Releases in video.js are done on npm and GitHub and eventually posted on the CDN.
Releases in Video.js are done on npm and GitHub and eventually posted on the CDN.
These are the instructions for the npm/GitHub releases.
When we do a release, we release it as a `next` tag on npm first and then at least a week later, we promote this release to `latest` on npm.
You can promote it using `npm dist-tag add video.js@<version> <tag>`.
### Getting dependencies
#### npm access
Expand All @@ -303,12 +304,6 @@ npm owner ls video.js
If you are a core committer, you can request access to npm from one of the current owners.
Access is managed via an [npm organization][npm org] for [Video.js][vjs npm].
#### GitHub personal access token
This is used to make a GitHub release on videojs. You can get a token from the [personal access tokens](https://github.com/settings/tokens) page.
After generating one, make sure to keep it safe because GitHub will not show the token for you again. A good place to save it is Lastpass Secure Notes.
### Deciding what type of version release
Since we follow the [conventional changelog conventions][conventions],
Expand All @@ -321,15 +316,14 @@ Most common releases will be either `patch` or `minor`.
### Doing a release
It is also recommended you have a clean clone of Video.js for each release line you want to release.
That means having a folder for main/v6 and one for 5.x.
This is because 5.x and 6.x have different versions expecations for release process and have different dependencies.
This is because different versions have different expectations for release process and have different dependencies.
Plus, during development you could end up with a dirty repo, so, it just usually easier if you have a clean release repo.
```sh
# for v6
git clone [email protected]:videojs/video.js.git videojs-6-release
# for v5
git clone [email protected]:videojs/video.js.git videojs-5-release
# for v8
git clone [email protected]:videojs/video.js.git videojs-8-release
# for v7
git clone [email protected]:videojs/video.js.git videojs-7-release
```
#### Current Video.js
Expand Down Expand Up @@ -362,21 +356,14 @@ relies on the commit being available on GitHub.
git push --tags origin main
```
Finally, run `npm publish` with an appropriate tag. Don't forget to supply your token.
```sh
VJS_GITHUB_USER=gkatsev VJS_GITHUB_TOKEN=my-personal-access-token npm publish --tag next
```
After it's done, verify that the GitHub release has the correct changelog output.
This is to make sure that the CHANGELOG didn't get garbled and isn't missing pieces.
After the tag was pushed, GitHub actions will trigger the `release` workflow, which will do the following:
If the GitHub release did not work correctly, such as if the GitHub token was not provided,
you can run it manually:
* Publish to npm with `next` or `next-{n}` depending on your current major version.
* Create GitHub pre-release with changelog and Netlify preview.
* Create a GitHub `releases` discussion linked to the GitHub release.
* Copy files to the CDN with the AWS CLI (this step requires approval, make sure to ping collaborators chat!)
```sh
VJS_GITHUB_USER=gkatsev VJS_GITHUB_TOKEN=123 node build/gh-release.js --prelease
```
And that's it. Congratulations - you've just released a new version of Video.js.
#### Legacy Video.js (5)
Expand Down

0 comments on commit 2e939e2

Please sign in to comment.