Skip to content

docs: clarify global gitignore and fix typos #627

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

Merged
merged 3 commits into from
Oct 27, 2022
Merged

docs: clarify global gitignore and fix typos #627

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e90209e
docs: fix typos
LiviaMedeiros Apr 26, 2022
991ff27
docs: clarify global gitignore file in README.md
LiviaMedeiros Apr 26, 2022
f5b9c76
add link to git docs
aduh95 Oct 27, 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
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ To obtain the Jenkins API token
token in the inbox that appears, and click `GENERATE`.
4. Copy the generated token.
5. Add it into your `ncurc` file (`~/.ncurc` or `$XDG_CONFIG_HOME/ncurc`)
with `jenkins_token` as key, like this
with `jenkins_token` as key, like this:

```json
{
Expand All @@ -113,7 +113,9 @@ To obtain the Jenkins API token

### Make sure your credentials won't be committed

Put the following entries into `~/.gitignore_global`
Put the following entries into your
[global `gitignore` file](https://git-scm.com/docs/git-config#Documentation/git-config.txt-coreexcludesFile)
(`$XDG_CONFIG_HOME/git/ignore` or a file specified by `core.excludesFile`):

```
# node-core-utils configuration file
Expand All @@ -122,7 +124,7 @@ Put the following entries into `~/.gitignore_global`
.ncu
```

Mind that`.ncu/land` could contain your access token since it contains the
Mind that `.ncu/land` could contain your access token since it contains the
serialized configurations.

If you ever accidentally commit your access token on GitHub, you can simply
Expand Down
2 changes: 1 addition & 1 deletion docs/ncu-ci.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ and then cache the responses from Jenkins so that the next time the command
is run, it picks up cached data written on disk for jobs whose results
are known.

Note: results are cached in `${ncu_intallation_path}/.ncu/cache`, so you
Note: results are cached in `${ncu_installation_path}/.ncu/cache`, so you
may want to clean it up from time to time.

```
Expand Down