Prepare the D&D collection for its first release
This commit is contained in:
30
README.md
30
README.md
@@ -4,16 +4,34 @@ An Ansible collection for installing and configuring the D&D
|
||||
transcript-processing pipeline on Ubuntu 26.04. The assembled pipeline role is
|
||||
available as `rakestraw.dnd.pipeline` and supports Ansible Core 2.18 or newer.
|
||||
|
||||
## Install from source
|
||||
Release `0.1.0` contains the reviewed `rakestraw.dnd_pipeline` `v0.1.0`
|
||||
snapshot and pins the Seriatim, Audita, Notarius, Scriptorium, and Narratio
|
||||
roles to their respective `v0.1.0` releases.
|
||||
|
||||
Bootstrap the collection's exact standalone-role and collection dependencies:
|
||||
## Install release 0.1.0
|
||||
|
||||
Download the tagged compatibility manifest and install its exact standalone
|
||||
role and collection dependencies:
|
||||
|
||||
```sh
|
||||
curl -fLO \
|
||||
https://gitea.maximumdirect.net/eric/ansible-collection-dnd/raw/tag/v0.1.0/requirements.yml
|
||||
ansible-galaxy install -r requirements.yml
|
||||
```
|
||||
|
||||
Build the collection into a temporary directory, then install the artifact
|
||||
without resolving dependencies a second time:
|
||||
Then install the published collection artifact without resolving dependencies
|
||||
a second time:
|
||||
|
||||
```sh
|
||||
ansible-galaxy collection install \
|
||||
https://gitea.maximumdirect.net/eric/ansible-collection-dnd/releases/download/v0.1.0/rakestraw-dnd-0.1.0.tar.gz \
|
||||
--no-deps
|
||||
```
|
||||
|
||||
## Build from source
|
||||
|
||||
Maintainers can build the collection into a temporary directory after
|
||||
installing `requirements.yml`:
|
||||
|
||||
```sh
|
||||
build_dir=$(mktemp -d)
|
||||
@@ -22,10 +40,6 @@ ansible-galaxy collection install \
|
||||
"$build_dir/rakestraw-dnd-0.1.0.tar.gz" --no-deps
|
||||
```
|
||||
|
||||
The development manifest uses immutable role commit pins. A future released
|
||||
collection may instead consume reviewed role tags; this repository does not
|
||||
claim that version `0.1.0` has been published or tagged.
|
||||
|
||||
## Use
|
||||
|
||||
```yaml
|
||||
|
||||
Reference in New Issue
Block a user