Skip to content
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

chore(docs): Remove outdated information in collaborators' guide #1271

Merged
merged 6 commits into from
May 2, 2022
Merged

chore(docs): Remove outdated information in collaborators' guide #1271

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6018eae
chore(docs): Remove outdated mention of gh token
mister-ben Apr 13, 2022
aa08dff
Fix: retain playlist attributes when refreshing live media playlists …
mister-ben Apr 13, 2022
82f9d98
Merge branch 'main' into mister-ben-patch-1
mister-ben Apr 13, 2022
a11c2a5
Merge branch 'main' into mister-ben-patch-1
mister-ben Apr 13, 2022
48ad8db
Merge branch 'main' into mister-ben-patch-1
mister-ben Apr 13, 2022
a3103b9
master->main, release unneeded
mister-ben Apr 13, 2022
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
11 changes: 1 addition & 10 deletions COLLABORATOR_GUIDE.md
View file
Open in desktop
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