Skip to content

Commit cc50ceb

Browse files
authored
fix(docs): Revise credential storage recommendations in README (#979)
* fix(docs): revise credential storage recommendations in README * fixup! fix(docs): revise credential storage recommendations in README
1 parent e41427a commit cc50ceb

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -89,14 +89,6 @@ After the token is generated, create an rc file with the following content:
8989
Note: you could use `ncu-config` to configure these variables, but it's not
9090
recommended to leave your tokens in your command line history.
9191

92-
If you have `gpg` installed and setup on your local machine, it is recommended
93-
to store an encrypted version of this file:
94-
95-
```console
96-
$ gpg --default-recipient-self --encrypt ~/.ncurc
97-
$ rm ~/.ncurc
98-
```
99-
10092
### Setting up Jenkins credentials
10193

10294
The `git-node` and `ncu-ci` commands need to query the Node.js Jenkins API for
@@ -124,14 +116,30 @@ To obtain the Jenkins API token
124116
}
125117
```
126118

119+
### Protecting your credentials
127120

128-
### Make sure your credentials won't be committed
121+
If you have `gpg` installed and setup on your local machine, it is strongly recommended
122+
to store an encrypted version of this file:
123+
124+
```console
125+
$ gpg --default-recipient-self --encrypt ~/.ncurc
126+
$ rm ~/.ncurc
127+
```
128+
129+
The credentials are now encrypted in `~/.ncurc.gpg` and everytime it's needed,
130+
node-core-utils will invoke `gpg` that may ask you to decrypt it using
131+
your default key via pinentry.
129132

130133
Put the following entries into your
131134
[global `gitignore` file](https://git-scm.com/docs/git-config#Documentation/git-config.txt-coreexcludesFile)
132-
(`$XDG_CONFIG_HOME/git/ignore` or a file specified by `core.excludesFile`):
135+
(`$XDG_CONFIG_HOME/git/ignore` or a file specified by `core.excludesFile`). For example:
136+
137+
```console
138+
$ git config --global core.excludesfile ~/.gitignore_global
139+
```
133140

134141
```
142+
# In ~/.gitignore_global
135143
# node-core-utils configuration file
136144
.ncurc
137145
.ncurc.gpg

0 commit comments

Comments
 (0)