Skip to content

Commit

Permalink
chore(docs): Remove outdated information in collaborators' guide (#1271)
Browse files Browse the repository at this point in the history
  • Loading branch information
mister-ben authored May 2, 2022
1 parent 8013830 commit 5223427
Showing 1 changed file with 1 addition and 10 deletions.
11 changes: 1 addition & 10 deletions COLLABORATOR_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
* [Releases](#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)
* [Doc credit](#doc-credit)
Expand All @@ -31,12 +30,6 @@ npm owner ls @videojs/http-streaming
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], all commits are prepended with a type, most commonly `feat` and `fix`.
Expand Down Expand Up @@ -81,7 +74,7 @@ Afterwards, you want to push the commit and the tag to the repo.
It's necessary to do this before running `npm publish` because our GitHub release automation relies on the commit being available on GitHub.

```sh
git push --follow-tags origin master
git push --follow-tags origin main
```

Publish to npm.
Expand All @@ -90,8 +83,6 @@ Publish to npm.
npm publish
```

After it's done, [create a release in github](https://github.com/videojs/http-streaming/releases/new) with latest tag, no title, description copied from [the changelog](https://github.com/videojs/http-streaming/blob/master/CHANGELOG.md), and the .min.js and .js dist files attached.

If it's a large enough release, consider writing a blog post as well.

## Doc credit
Expand Down

0 comments on commit 5223427

Please sign in to comment.