Skip to content

Commit

Permalink
Typofix in README.adoc (knl#47)
Browse files Browse the repository at this point in the history
Update README.adoc
  • Loading branch information
ggreif authored Mar 16, 2022
1 parent 946b812 commit 81ce2ff
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
= 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)]

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:

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.

Expand Down Expand Up @@ -53,13 +53,13 @@ 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
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.
Expand Down Expand Up @@ -101,12 +101,12 @@ 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`.

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]
----
Expand Down

0 comments on commit 81ce2ff

Please sign in to comment.