Skip to content
This repository has been archived by the owner on Nov 1, 2022. It is now read-only.

Commit

Permalink
Merge pull request #2457 from chrisfowles/1363-update-windows-install…
Browse files Browse the repository at this point in the history
…-doco

Update install doco to include chocolatey
  • Loading branch information
stefanprodan authored Sep 20, 2019
2 parents 8f99075 + 76140d1 commit 430814d
Showing 1 changed file with 43 additions and 27 deletions.
70 changes: 43 additions & 27 deletions docs/references/fluxctl.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,20 @@ cd fluxctl-bin
makepkg -si
```

### Windows

#### Chocolatey

[Chocolatey](https://chocolatey.org/) is a third party package manager for Windows.

If you haven't already installed chocolatey you will need to [do this first](https://chocolatey.org/install).

fluxctl can then be installed from the [public package repository](https://chocolatey.org/packages/fluxctl):

```powershell
choco install fluxctl
```

### Binary releases

With every release of Flux, we release binaries of `fluxctl` for Mac, Linux
Expand Down Expand Up @@ -545,45 +559,47 @@ retrieves from the registry.

Commit customization

1. Commit message
```text
1. Commit message
fluxctl --message="Message providing more context for the action" .....
fluxctl --message="Message providing more context for the action" .....
2. Committer
2. Committer
Committer information can be overriden with the appropriate fluxd flags:
Committer information can be overriden with the appropriate fluxd flags:
--git-user
--git-email
--git-user
--git-email
See [docs/features/daemon.md] for more information.
See [docs/features/daemon.md] for more information.
3. Commit author
3. Commit author
The default for the author is the committer information, which can be overriden,
in the following manner:
The default for the author is the committer information, which can be overriden,
in the following manner:
a) Default override uses user's git configuration, ie user.name
and user.email (.gitconfig) to set the commit author.
If the user has neither user.name nor for
user.email set up, the committer information will be used. If only one
is set up, that will be used.
a) Default override uses user's git configuration, ie user.name
and user.email (.gitconfig) to set the commit author.
If the user has neither user.name nor for
user.email set up, the committer information will be used. If only one
is set up, that will be used.
b) This can be further overriden by the use of the fluxctl --user flag.
b) This can be further overriden by the use of the fluxctl --user flag.
Examples
Examples
a) fluxctl --user="Jane Doe <jane@doe.com>" ......
This will always succeed as git expects a new author in the format
"some_string <some_other_string>".
a) fluxctl --user="Jane Doe <jane@doe.com>" ......
This will always succeed as git expects a new author in the format
"some_string <some_other_string>".
b) fluxctl --user="Jane Doe" .......
This form will succeed if there is already a repo commit, done by
Jane Doe.
b) fluxctl --user="Jane Doe" .......
This form will succeed if there is already a repo commit, done by
Jane Doe.
c) fluxctl --user="jane@doe.com" .......
This form will succeed if there is already a repo commit, done by
jane@doe.com.
c) fluxctl --user="jane@doe.com" .......
This form will succeed if there is already a repo commit, done by
jane@doe.com.
```

### Errors due to author customization

Expand All @@ -602,7 +618,7 @@ Automation and image tag filtering can also be managed using annotations

Automation can be enabled with `fluxcd.io/automated: "true"`. Image
filtering annotations take the form
`fluxcd.io/tag.<container-name>: <filter-type>:<filter-value>` or
`fluxcd.io/tag.<container-name>: <filter-type>:<filter-value>` or
`filter.fluxcd.io/<container-name>: <filter-type>:<filter-value>`. Values of
`filter-type` can be [`glob`](#glob), [`semver`](#semver), and
[`regexp`](#regexp). Filter values use the same syntax as when the filter is
Expand Down

0 comments on commit 430814d

Please sign in to comment.