This repository has been archived by the owner on Nov 8, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
82 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
node_modules/ | ||
yarn.lock | ||
/node_modules/ | ||
/yarn.lock |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
/.travis.yml | ||
/maintain.md | ||
/test.js | ||
/yarn.lock |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# Release a new version | ||
|
||
## Run all the checks | ||
|
||
```bash | ||
$ npm test | ||
``` | ||
|
||
## Increase the version number | ||
|
||
In [package.json](package.json) to `7.8.9` in this example. | ||
|
||
## Generate the package to be published | ||
|
||
```bash | ||
$ npm pack | ||
``` | ||
|
||
And check that the resulting `ghuser-github-contribs-7.8.9.tgz` looks well-formed. Finally clean up: | ||
|
||
```bash | ||
$ rm ghuser-github-contribs-7.8.9.tgz | ||
``` | ||
|
||
## Install the package locally | ||
|
||
```bash | ||
$ sudo npm install . -g | ||
``` | ||
|
||
and test it briefly, e.g. | ||
|
||
```bash | ||
$ github-contribs --version | ||
$ github-contribs --since 2018-05-29 AurelienLourot | ||
``` | ||
|
||
## Commit your changes, create a git tag and push | ||
|
||
```bash | ||
$ git commit -am "Version 7.8.9" | ||
$ git push | ||
$ git tag "7.8.9" | ||
$ git push --tags | ||
``` | ||
|
||
## Publish the package | ||
|
||
```bash | ||
$ npm login --scope=@ghuser | ||
Username: lourot | ||
... | ||
$ npm publish | ||
``` | ||
|
||
> **NOTES**: | ||
> | ||
> * If it fails with 301, see | ||
> [publish - npm login error 301](https://stackoverflow.com/a/50580349/1855917). | ||
> * On the first publication do `npm publish --access public` instead. | ||
and check that the package looks well-formed at | ||
`https://www.npmjs.com/package/@ghuser/github-contribs/v/7.8.9` | ||
|
||
Finally check that the package can be installed from npm: | ||
|
||
```bash | ||
$ sudo npm uninstall -g @ghuser/github-contribs | ||
$ sudo npm install -g @ghuser/github-contribs | ||
``` | ||
|
||
## Add release notes | ||
|
||
to [https://github.com/AurelienLourot/github-contribs/tags](https://github.com/AurelienLourot/github-contribs/tags) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters