forked from vieter-v/vieter
docs: forgot some renames
parent
fcdcf9c5ca
commit
cf94b64400
|
@ -15,7 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||||
|
|
||||||
* Moved all API routes under `/v1` namespace
|
* Moved all API routes under `/v1` namespace
|
||||||
* Renamed `vieter repos` to `vieter targets`
|
* Renamed `vieter repos` to `vieter targets`
|
||||||
* Renamed `/v1/api/repos` namespace to `/v1/api/targets`
|
* Renamed `/api/v1/repos` namespace to `/api/v1/targets`
|
||||||
|
|
||||||
## [0.3.0](https://git.rustybever.be/vieter/vieter/src/tag/0.3.0)
|
## [0.3.0](https://git.rustybever.be/vieter/vieter/src/tag/0.3.0)
|
||||||
|
|
||||||
|
|
|
@ -26,7 +26,7 @@ secrets file.
|
||||||
## Commands
|
## Commands
|
||||||
|
|
||||||
The first argument passed to Vieter determines which command you wish to use.
|
The first argument passed to Vieter determines which command you wish to use.
|
||||||
Each of these can contain subcommands (e.g. `vieter repos list`), but all
|
Each of these can contain subcommands (e.g. `vieter targets list`), but all
|
||||||
subcommands will use the same configuration. Below you can find the
|
subcommands will use the same configuration. Below you can find the
|
||||||
configuration variable required for each command.
|
configuration variable required for each command.
|
||||||
|
|
||||||
|
@ -89,11 +89,11 @@ configuration variable required for each command.
|
||||||
* `api_key`: the API key to use when authenticating requests.
|
* `api_key`: the API key to use when authenticating requests.
|
||||||
* `address`: Base URL of your Vieter instance, e.g. https://example.com
|
* `address`: Base URL of your Vieter instance, e.g. https://example.com
|
||||||
|
|
||||||
### `vieter repos`
|
### `vieter targets`
|
||||||
|
|
||||||
* `api_key`: the API key to use when authenticating requests.
|
* `api_key`: the API key to use when authenticating requests.
|
||||||
* `address`: Base URL of your Vieter instance, e.g. https://example.com
|
* `address`: Base URL of your Vieter instance, e.g. https://example.com
|
||||||
* `base_image`: image to use when building a package using `vieter repos
|
* `base_image`: image to use when building a package using `vieter targets
|
||||||
build`.
|
build`.
|
||||||
* Default: `archlinux:base-devel`
|
* Default: `archlinux:base-devel`
|
||||||
|
|
||||||
|
|
|
@ -16,11 +16,11 @@ info to the system. The Vieter repository server exposes an HTTP API for this
|
||||||
info). For ease of use, the Vieter binary contains a CLI interface for
|
info). For ease of use, the Vieter binary contains a CLI interface for
|
||||||
interacting with this API (see [Configuration](/configuration) for
|
interacting with this API (see [Configuration](/configuration) for
|
||||||
configuration details). The [man
|
configuration details). The [man
|
||||||
pages](https://rustybever.be/man/vieter/vieter-repos.1.html) describe this in
|
pages](https://rustybever.be/man/vieter/vieter-targets.1.html) describe this in
|
||||||
greater detail, but the basic usage is as follows:
|
greater detail, but the basic usage is as follows:
|
||||||
|
|
||||||
```
|
```
|
||||||
vieter repos add some-url some-branch some-repository
|
vieter targets add some-url some-branch some-repository
|
||||||
```
|
```
|
||||||
|
|
||||||
Here, `some-url` is the URL of the Git repository containing the PKGBUILD. This
|
Here, `some-url` is the URL of the Git repository containing the PKGBUILD. This
|
||||||
|
@ -37,7 +37,7 @@ should be published.
|
||||||
The above command intentionally leaves out a few parameters to make the CLI
|
The above command intentionally leaves out a few parameters to make the CLI
|
||||||
more useable. For information on how to modify all parameters using the CLI,
|
more useable. For information on how to modify all parameters using the CLI,
|
||||||
see
|
see
|
||||||
[vieter-repos-edit(1)](https://rustybever.be/man/vieter/vieter-repos-edit.1.html).
|
[vieter-targets-edit(1)](https://rustybever.be/man/vieter/vieter-targets-edit.1.html).
|
||||||
|
|
||||||
## Reading logs
|
## Reading logs
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue