docs: updated to new 'kind' field
ci/woodpecker/pr/docs Pipeline was successful
Details
ci/woodpecker/pr/lint Pipeline was successful
Details
ci/woodpecker/pr/build Pipeline was successful
Details
ci/woodpecker/pr/docker Pipeline was successful
Details
ci/woodpecker/pr/man Pipeline was successful
Details
ci/woodpecker/pr/test Pipeline was successful
Details
ci/woodpecker/pr/docs Pipeline was successful
Details
ci/woodpecker/pr/lint Pipeline was successful
Details
ci/woodpecker/pr/build Pipeline was successful
Details
ci/woodpecker/pr/docker Pipeline was successful
Details
ci/woodpecker/pr/man Pipeline was successful
Details
ci/woodpecker/pr/test Pipeline was successful
Details
parent
8f91c1fde5
commit
449656eb97
|
@ -10,12 +10,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
* Server port can now be configured
|
* Server port can now be configured
|
||||||
|
* Targets now have a 'kind' field describing whether it's a Git repository or a
|
||||||
|
URL to a PKGBUILD
|
||||||
|
* Targets with kind 'url' can provide a direct URL to a PKGBUILD instead of
|
||||||
|
providing a Git repository
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
* 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 `/api/v1/repos` namespace to `/api/v1/targets`
|
* Renamed `/api/v1/repos` namespace to `/api/v1/targets`
|
||||||
|
* Branch name for 'git' targets is now optional; if not provided, the
|
||||||
|
repository will be cloned with the default branch
|
||||||
|
|
||||||
### Removed
|
### Removed
|
||||||
|
|
||||||
|
|
|
@ -24,6 +24,7 @@ curl \
|
||||||
"data": [
|
"data": [
|
||||||
{
|
{
|
||||||
"id": 1,
|
"id": 1,
|
||||||
|
"kind": "git",
|
||||||
"url": "https://aur.archlinux.org/discord-ptb.git",
|
"url": "https://aur.archlinux.org/discord-ptb.git",
|
||||||
"branch": "master",
|
"branch": "master",
|
||||||
"repo": "bur",
|
"repo": "bur",
|
||||||
|
@ -69,6 +70,7 @@ curl \
|
||||||
"message": "",
|
"message": "",
|
||||||
"data": {
|
"data": {
|
||||||
"id": 1,
|
"id": 1,
|
||||||
|
"kind": "git",
|
||||||
"url": "https://aur.archlinux.org/discord-ptb.git",
|
"url": "https://aur.archlinux.org/discord-ptb.git",
|
||||||
"branch": "master",
|
"branch": "master",
|
||||||
"repo": "bur",
|
"repo": "bur",
|
||||||
|
@ -108,6 +110,7 @@ Create a new target with the given data.
|
||||||
|
|
||||||
Parameter | Description
|
Parameter | Description
|
||||||
--------- | -----------
|
--------- | -----------
|
||||||
|
kind | Kind of target to add; one of 'git', 'url'.
|
||||||
url | URL of the Git repository.
|
url | URL of the Git repository.
|
||||||
branch | Branch of the Git repository.
|
branch | Branch of the Git repository.
|
||||||
repo | Vieter repository to publish built packages to.
|
repo | Vieter repository to publish built packages to.
|
||||||
|
@ -132,6 +135,7 @@ id | id of target to modify
|
||||||
|
|
||||||
Parameter | Description
|
Parameter | Description
|
||||||
--------- | -----------
|
--------- | -----------
|
||||||
|
kind | Kind of target; one of 'git', 'url'.
|
||||||
url | URL of the Git repository.
|
url | URL of the Git repository.
|
||||||
branch | Branch of the Git repository.
|
branch | Branch of the Git repository.
|
||||||
repo | Vieter repository to publish built packages to.
|
repo | Vieter repository to publish built packages to.
|
||||||
|
|
|
@ -20,24 +20,24 @@ 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 targets add some-url some-branch some-repository
|
vieter targets add some-url 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
|
||||||
URL is passed to `git clone`, meaning the repository should be public. Vieter
|
URL is passed to `git clone`, meaning the repository should be public. Vieter
|
||||||
expects the same format as an AUR Git repository, so you can directly use AUR
|
expects the same format as an AUR Git repository, so you can directly use AUR
|
||||||
URLs here.
|
URLs here. Alternatively, you can also provide the URL to a PKGBUILD file
|
||||||
|
instead. See
|
||||||
|
[vieter-targets-add(1)](https://rustybever.be/man/vieter/vieter-targets-add.1.html)
|
||||||
|
for more information.
|
||||||
|
|
||||||
`some-branch` is the branch of the Git repository the build should check out.
|
`some-repo` is the repository to which the built package archives should be
|
||||||
If you're using an AUR package, this should be `master`.
|
published.
|
||||||
|
|
||||||
Finally, `some-repo` is the repository to which the built package archives
|
|
||||||
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-targets-edit(1)](https://rustybever.be/man/vieter/vieter-targets-edit.1.html).
|
[vieter-targets(1)](https://rustybever.be/man/vieter/vieter-targets.1.html).
|
||||||
|
|
||||||
## Reading logs
|
## Reading logs
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue