https://github.com/actungs/container-structure-test-action
An action to setup the container-structure-test executable.
https://github.com/actungs/container-structure-test-action
composite-action container-structure-test github-actions
Last synced: 2 months ago
JSON representation
An action to setup the container-structure-test executable.
- Host: GitHub
- URL: https://github.com/actungs/container-structure-test-action
- Owner: actungs
- License: mit
- Created: 2024-01-05T21:26:23.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2026-04-13T05:37:56.000Z (2 months ago)
- Last Synced: 2026-04-13T07:25:12.829Z (2 months ago)
- Topics: composite-action, container-structure-test, github-actions
- Homepage: https://github.com/marketplace/actions/container-structure-test-composite-action
- Size: 28.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Container Structure Test Action
An action to setup, cache and run the [GoogleContainerTools/container-structure-test](https://github.com/GoogleContainerTools/container-structure-test) executable.
[actions/cache](https://github.com/actions/cache) is used to cache the executable under `-container-structure-test`.
The cache should be deleted if the executable should be re-installed.
> [!NOTE]
> Currently this action only supports Linux and macOS GitHub runners.
## Usage
```yaml
- uses: actungs/container-structure-test-action@v1
with:
# The full docker image tag to be verified.
#
# Required.
image: ''
# The path to the container structure configuration files.
#
# Required.
config_files: ''
# The version of container-structure-test to be installed.
# See the key property in https://storage.googleapis.com/container-structure-test for available versions.
#
# Default: 'latest'
version: ''
# The path to where the executable will be installed to.
#
# Default: '.bin'
install_path: ''
# Set to 'false' if color should be used in the output.
#
# Default: 'true'
no_color: ''
# Set to 'true' to force a pull of the image before running the tests.
#
# Default: 'false'
pull_image: ''
# The output format for the test report. Available format: text, json, junit.
#
# Default: 'text'
output_format: ''
# Write the test report to the specified file. Supported file types are json and junit.
# Set the `output_format` accordingly.
# If the `output_format` does not match the given file type, then `json` will be used instead.
#
# Default: ''
report_file: ''
```
## Example
A simplified example, on how this action can be utilized, could look like this.
```yaml
"on": [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
# Build the container image
# ...
# Run the container test, assuming the image is 'actungs/test-image:local' and the configuration file is 'config.yaml'.
- uses: actungs/container-structure-test-action@v1
with:
image: actungs/test-image:local
config_files: config.yaml
```
## License
This project is released under the [MIT License](./LICENSE).