diff --git a/README.md b/README.md index 2c78c17..9dd785f 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,14 @@ ### What is it? -This is a GitHub Action you may use in your Workflow to import into Microcks some API specification files. This allow keeping your API definitions, mocks and tests up-to-date into Microcks.. This action is basically a wrapper around the [Microcks CLI](https://github.com/microcks/microcks-cli) and provides the same configuration capabilities. +This is a GitHub Action you may use in your Workflow to import into Microcks some API specification files. This allow keeping your API definitions, mocks and tests up-to-date into Microcks.. This action is basically a wrapper around the [Microcks CLI](https://github.com/microcks/microcks-cli) and provides the same configuration capabilities. The `import` command of the CLI just need 1 argument: + * `` : Comma separated list of API specs to import with flag telling if it's a primary artifact. Example: `'specs/my-openapi.yaml:true,specs/my-postmancollection.json:false'` With a bunch of mandatory flags: + * `--microcksURL` for the Microcks API endpoint, * `--keycloakClientId` for the Keycloak Realm Service Account ClientId, * `--keycloakClientSecret` for the Keycloak Realm Service Account ClientSecret. diff --git a/action.yml b/action.yml index f169af0..191e425 100644 --- a/action.yml +++ b/action.yml @@ -16,7 +16,7 @@ inputs: required: true runs: using: 'docker' - image: 'docker://quay.io/microcks/microcks-cli:0.4.0' + image: 'docker://quay.io/microcks/microcks-cli:0.5.0' entrypoint: '/usr/bin/bash' args: - '-c'