From 0c53edcbda727233454862e2db8b6b5382d99a50 Mon Sep 17 00:00:00 2001 From: Gabor Greif Date: Thu, 8 Jul 2021 16:40:41 +0200 Subject: [PATCH 1/6] Update README.adoc --- README.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index f9aa1d8..cf1ada2 100644 --- a/README.adoc +++ b/README.adoc @@ -106,7 +106,7 @@ jobs: locally. Defaults to `false`. As the above list suggests, `niv-updater-action` is highly configurable. -The following example exposes some of the nobs, many with their default values: +The following example exposes some of the knobs, many with their default values: [source,yaml] ---- From dad8d1a16a5007621b2a84819ba4e520551567c4 Mon Sep 17 00:00:00 2001 From: Gabor Greif Date: Fri, 9 Jul 2021 17:34:14 +0200 Subject: [PATCH 2/6] make markup consistent --- README.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index cf1ada2..1a8eec4 100644 --- a/README.adoc +++ b/README.adoc @@ -59,7 +59,7 @@ jobs: this action. The action does not sanitize the branch name. For a description of what a valid branch name is, please consult: https://mirrors.edge.kernel.org/pub/software/scm/git/docs/git-check-ref-format.html. - Defaults to "update/". + Defaults to `update/`. * `keep_updating`: (Optional) If PR already exists, keep it updated with new changes. The branch will be force updated, as this process keeps a single commit on a branch. Defaults to `false` to maintain the old behaviour. From 9058d8d147abfe089af9390390ad9e5ca0f34e6b Mon Sep 17 00:00:00 2001 From: Gabor Greif Date: Fri, 9 Jul 2021 18:14:03 +0200 Subject: [PATCH 3/6] markup --- README.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index 1a8eec4..989ac98 100644 --- a/README.adoc +++ b/README.adoc @@ -3,7 +3,7 @@ image:https://github.com/knl/niv-updater-action/workflows/CI/badge.svg[CI] image:https://img.shields.io/github/v/release/knl/niv-updater-action[GitHub release (latest by date)] -This action will open a pull request to master branch (or otherwise specified +This action will open a pull request to `master` branch (or otherwise specified branch) whenever https://github.com/nmattia/niv[niv] detects updates to `nix/sources.json` in your repository, for each dependency separately. Each PR will contain a beautiful Changelog of all the changes in the update, like this: From 0cfd43c020269fb0639c2a4257c95ffb4a7a832e Mon Sep 17 00:00:00 2001 From: Gabor Greif Date: Fri, 9 Jul 2021 18:16:28 +0200 Subject: [PATCH 4/6] markup --- README.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.adoc b/README.adoc index 989ac98..db64ff7 100644 --- a/README.adoc +++ b/README.adoc @@ -10,7 +10,7 @@ will contain a beautiful Changelog of all the changes in the update, like this: image:./assets/niv-update-action-changelog.png[title="Changelog generated by niv-updater-action] -The best way to use niv-updater-action is to set up a scheduled workflow. This +The best way to use `niv-updater-action` is to set up a scheduled workflow. This way, whenever there are new updates, you will get a PR that you can just approve and avoid a lot of manual work. @@ -53,7 +53,7 @@ jobs: This value will be passed to niv via `--sources-file` option. Defaults to `nix/sources.json`. * `niv_version`: (Optional) The niv version to be used. Defaults to `master`, - meaning niv-updater-action will take the latest niv for each run. You may want + meaning `niv-updater-action` will take the latest niv for each run. You may want to fix a particular version and avoid future breaks to your workflow. * `branch_prefix`: (Optional) The prefix used for update branches, created by this action. The action does not sanitize the branch name. For a description From f6a32b72ff20f0f3c8187888350aaed25c1c0774 Mon Sep 17 00:00:00 2001 From: Gabor Greif Date: Fri, 9 Jul 2021 18:19:35 +0200 Subject: [PATCH 5/6] another typo --- README.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index db64ff7..881f481 100644 --- a/README.adoc +++ b/README.adoc @@ -101,7 +101,7 @@ jobs: https://github.com/knl/niv-updater-action/issues/26[Issue #26]. Defaults to `true`. * `debug_output`: (Optional, a boolean) If `true`, `set -x` will be turned on - for the updater script, outputing every step the action takes. This will show + for the updater script, outputting every step the action takes. This will show up in the action log, and could be useful for trying to reproduce issues locally. Defaults to `false`. From 92c8e8f89f0117863a80ba7186d60a61798c5c74 Mon Sep 17 00:00:00 2001 From: Gabor Greif Date: Fri, 9 Jul 2021 18:22:26 +0200 Subject: [PATCH 6/6] tweak --- README.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index 881f481..3b1a84f 100644 --- a/README.adoc +++ b/README.adoc @@ -1,4 +1,4 @@ -= niv-updater: Automated dependency updates with niv += niv-updater: Automated dependency updates with niv image:https://github.com/knl/niv-updater-action/workflows/CI/badge.svg[CI] image:https://img.shields.io/github/v/release/knl/niv-updater-action[GitHub release (latest by date)]