Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 1 addition & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@ ci: ## Execute local CI tasks
$(MAKE) test

docs: ## Generate action documentation
npm exec --yes --package=@ci-dokumentor/cli@0.5.0 -- ci-dokumentor generate --source actions/vm/create/action.yml actions/vm/test/action.yml actions/vm/destroy/action.yml --repository git
# The new Ansible action has no released version for automatic usage examples.
npm exec --yes --package=@ci-dokumentor/cli@0.5.0 -- ci-dokumentor generate --source actions/ansible/test/action.yml --repository git --exclude-sections usage
npm exec --yes --package=@ci-dokumentor/cli@0.5.0 -- ci-dokumentor generate --source actions/ansible/test/action.yml actions/vm/create/action.yml actions/vm/test/action.yml actions/vm/destroy/action.yml --repository git

#############################
# Helpers
Expand Down
42 changes: 42 additions & 0 deletions actions/ansible/test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,3 +113,45 @@ for matrix entries.
This documentation was automatically generated by [CI Dokumentor](https://github.com/hoverkraft-tech/ci-dokumentor).

<!-- generated:end -->
<!-- usage:start -->

## Usage

```yaml
- uses: hoverkraft-tech/ci-github-iac/actions/ansible/test@5c4b7307d7a2c58a01a3b62607cebde65f96b0a2 # 0.2.0
with:
# Checkout-relative requirements file containing exactly one stable ansible-core==X.Y.Z pin.
# This input is required.
ansible-requirements: ""

# Checkout-relative playbook containing test assertions. This playbook is executed. Supply test-playbook or collection, exclusively.
test-playbook: ""

# One checked-out collection directory containing galaxy.yml. Use a matrix for multiple collections.
collection: ""

# Optional Python major.minor for collection sanity checks. Empty tests all versions supported by Ansible Core.
target-python-version: ""

# Optional checkout-relative inventory file for test playbook execution.
inventory: ""

# Optional checkout-relative ansible.cfg file for test playbook execution.
ansible-config: ""

# Optional checkout-relative first-party collection search directory containing ansible_collections.
collections-path: ""

# Optional checkout-relative Galaxy requirements file for third-party role and collection dependencies.
galaxy-requirements: ""

# Stable summary and PR comment title, distinct for each test step or matrix entry.
# Default: `Ansible test results`
report-name: Ansible test results

# Token for PR comments; requires pull-requests write. Fork and Dependabot comments are skipped.
# Default: `${{ github.token }}`
github-token: ${{ github.token }}
```

<!-- usage:end -->
2 changes: 1 addition & 1 deletion actions/vm/create/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ application-specific resources such as remote browser devices.
## Usage

```yaml
- uses: hoverkraft-tech/ci-github-iac/actions/vm/create@70843368d5f5f7b0a2cec1e8435d81cc40beee64 # 0.1.0
- uses: hoverkraft-tech/ci-github-iac/actions/vm/create@5c4b7307d7a2c58a01a3b62607cebde65f96b0a2 # 0.2.0
with:
# Path to a Lima YAML file in the checkout. Plain mode is enforced.
# This input is required.
Expand Down
2 changes: 1 addition & 1 deletion actions/vm/destroy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ and cloud resource cleanup are outside scope.
## Usage

```yaml
- uses: hoverkraft-tech/ci-github-iac/actions/vm/destroy@70843368d5f5f7b0a2cec1e8435d81cc40beee64 # 0.1.0
- uses: hoverkraft-tech/ci-github-iac/actions/vm/destroy@5c4b7307d7a2c58a01a3b62607cebde65f96b0a2 # 0.2.0
with:
# Private runtime directory returned by vm/create; repeated deletion is safe.
# This input is required.
Expand Down
2 changes: 1 addition & 1 deletion actions/vm/test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ No extra reporting steps are needed in the workflow.
## Usage

```yaml
- uses: hoverkraft-tech/ci-github-iac/actions/vm/test@70843368d5f5f7b0a2cec1e8435d81cc40beee64 # 0.1.0
- uses: hoverkraft-tech/ci-github-iac/actions/vm/test@5c4b7307d7a2c58a01a3b62607cebde65f96b0a2 # 0.2.0
with:
# Private runtime directory returned by vm/create.
# This input is required.
Expand Down
Loading