From e90209e261c410791a02757eb7196996e7505009 Mon Sep 17 00:00:00 2001 From: LiviaMedeiros Date: Tue, 26 Apr 2022 20:53:23 +0800 Subject: [PATCH 1/3] docs: fix typos --- README.md | 2 +- docs/ncu-ci.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f8fd4b16..9cfbca46 100644 --- a/README.md +++ b/README.md @@ -122,7 +122,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 diff --git a/docs/ncu-ci.md b/docs/ncu-ci.md index 423a7b49..6b0c72fe 100644 --- a/docs/ncu-ci.md +++ b/docs/ncu-ci.md @@ -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. ``` From 991ff27a66ad8880066884ad6771462a0b6aa30b Mon Sep 17 00:00:00 2001 From: LiviaMedeiros Date: Wed, 27 Apr 2022 01:15:17 +0800 Subject: [PATCH 2/3] docs: clarify global gitignore file in README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9cfbca46..a4797a99 100644 --- a/README.md +++ b/README.md @@ -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 { @@ -113,7 +113,8 @@ 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 +(`$XDG_CONFIG_HOME/git/ignore` or a file specified by `core.excludesFile`): ``` # node-core-utils configuration file From f5b9c766ed6354ebe86bccac95ce54e822757c21 Mon Sep 17 00:00:00 2001 From: Antoine du Hamel Date: Fri, 28 Oct 2022 01:40:18 +0200 Subject: [PATCH 3/3] add link to git docs --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a4797a99..60e0a361 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,8 @@ To obtain the Jenkins API token ### Make sure your credentials won't be committed -Put the following entries into your global gitignore file +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`): ```