Skip to content
This repository was archived by the owner on Nov 8, 2020. It is now read-only.

Commit c1e0e88

Browse files
committed
Publish to npm.
1 parent 1929fe3 commit c1e0e88

5 files changed

Lines changed: 82 additions & 8 deletions

File tree

.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
node_modules/
2-
yarn.lock
1+
/node_modules/
2+
/yarn.lock

.npmignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/.travis.yml
2+
/maintain.md
3+
/test.js
4+
/yarn.lock

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ dracula/gitk
3030
3131
3232
```bash
33-
$ sudo npm install -g github-contribs
33+
$ sudo npm install -g @ghuser/github-contribs
3434
```
3535
3636
## Team

maintain.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Release a new version
2+
3+
## Run all the checks
4+
5+
```bash
6+
$ npm test
7+
```
8+
9+
## Increase the version number
10+
11+
In [package.json](package.json) to `7.8.9` in this example.
12+
13+
## Generate the package to be published
14+
15+
```bash
16+
$ npm pack
17+
```
18+
19+
And check that the resulting `ghuser-github-contribs-7.8.9.tgz` looks well-formed. Finally clean up:
20+
21+
```bash
22+
$ rm ghuser-github-contribs-7.8.9.tgz
23+
```
24+
25+
## Install the package locally
26+
27+
```bash
28+
$ sudo npm install . -g
29+
```
30+
31+
and test it briefly, e.g.
32+
33+
```bash
34+
$ github-contribs --version
35+
$ github-contribs --since 2018-05-29 AurelienLourot
36+
```
37+
38+
## Commit your changes, create a git tag and push
39+
40+
```bash
41+
$ git commit -am "Version 7.8.9"
42+
$ git push
43+
$ git tag "7.8.9"
44+
$ git push --tags
45+
```
46+
47+
## Publish the package
48+
49+
```bash
50+
$ npm login --scope=@ghuser
51+
Username: lourot
52+
...
53+
$ npm publish
54+
```
55+
56+
> **NOTES**:
57+
>
58+
> * If it fails with 301, see
59+
> [publish - npm login error 301](https://stackoverflow.com/a/50580349/1855917).
60+
> * On the first publication do `npm publish --access public` instead.
61+
62+
and check that the package looks well-formed at
63+
`https://www.npmjs.com/package/@ghuser/github-contribs/v/7.8.9`
64+
65+
Finally check that the package can be installed from npm:
66+
67+
```bash
68+
$ sudo npm uninstall -g @ghuser/github-contribs
69+
$ sudo npm install -g @ghuser/github-contribs
70+
```
71+
72+
## Add release notes
73+
74+
to [https://github.com/AurelienLourot/github-contribs/tags](https://github.com/AurelienLourot/github-contribs/tags)

package.json

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "github-contribs",
2+
"name": "@ghuser/github-contribs",
33
"version": "0.0.1",
44
"description": "List all GitHub repos a user has contributed to since the beginning of time.",
55
"license": "Unlicense",
@@ -19,10 +19,6 @@
1919
"scripts": {
2020
"test": "xo && ava"
2121
},
22-
"files": [
23-
"index.js",
24-
"cli.js"
25-
],
2622
"keywords": [
2723
"cli-app",
2824
"cli",

0 commit comments

Comments
 (0)