Create mender artifact module-image docker action
This actions generates an mender artifact file.
The action is running in a docker container.
It uses the current mender-artifact version 3.6.1.
See the mender-artifact documentation page for more information.
Inputs
artifact-name
Description:
Name of the artifact
Required: true
device-type
Description:
Type of device(s) supported by the Artifact. You can specify multiple compatible devices providing this parameter multiple times.
Required: true
type
Description:
Type of payload. This is the same as the name of the update module.
Required: true
artifact-content
Description:
Content for the artifact payload, based on the payload type.
Required: true
output-path
Description:
Full path to output artifact file.
Required: true
state-scripts
Description:
Full path to the state script(s). You can specify multiple scripts providing this parameter multiple times.
Required: false
See mender documentation state-scripts for more information.
software-name
Description:
Name of the key to store the software version: rootfs-image.NAME.version, instead of rootfs-image.PAYLOAD_TYPE.version.
Required: false
software-version
Description:
Value for the software version, defaults to the name of the artifact.
Required: false
See mender documentation software versioning for more information.
Outputs
path-to-artifact
The path to the generated mender artifact.
Example usage
- name: create mender artifact
id: artifact
uses: KevinRohn/create-mender-artifact@main
with:
artifact-name: "test-artifact"
device-type: "raspberrypi3" # device type, add multiple device types with comma separator (e.g.: "raspberrypi3,mydevice" )
type: "deb" # module type
artifact-content: "content" # contains *.deb files
output-path: "out"
state-scripts: "state_scripts" # optional: folder to the state scripts
software-name: "my-app" # optional: software name
software-version: "v1.0" # optional: software version
- name: check-output
run: |
echo ${{ steps.artifact.outputs.path-to-artifact }}Progress
| Options | State |
|---|---|
| --artifact-name | ✅ |
| --device-type | ✅ |
| --type | ✅ |
| --artifact-name-depends | ❌ |
| --augment-file | ❌ |
| --augment-meta-data | ❌ |
| --augment-provides | ❌ |
| --augment-type | ❌ |
| --clears-provides | ❌ |
| --compression | ❌ |
| --depends | ❌ |
| --depends-groups | ❌ |
| --file | ✅ |
| --key | ❌ |
| --meta-data | ❌ |
| --no-default-clears-provides | ❌ |
| --no-default-software-version | ❌ |
| --output-path | ✅ |
| --provides | ❌ |
| --provides-group | ❌ |
| --script | ✅ |
| --software-filesystem | ❌ |
| --software-name | ✅ |
| --software-version | ✅ |
| --version | ❌ |