Skip to content
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

Typofix in README.adoc #47

Merged
merged 7 commits into from
Mar 16, 2022
Merged

Typofix in README.adoc #47

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0c53edc
Update README.adoc
ggreif Jul 8, 2021
dad8d1a
make markup consistent
ggreif Jul 9, 2021
9058d8d
markup
ggreif Jul 9, 2021
0cfd43c
markup
ggreif Jul 9, 2021
f6a32b7
another typo
ggreif Jul 9, 2021
92c8e8f
tweak
ggreif Jul 9, 2021
a43e3e5
Merge branch 'main' into patch-1
knl Mar 16, 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
14 changes: 7 additions & 7 deletions README.adoc
View file
Open in desktop
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