diff --git a/Makefile b/Makefile deleted file mode 100644 index dc7415e..0000000 --- a/Makefile +++ /dev/null @@ -1,10 +0,0 @@ -SHELL := /bin/bash - -# List of targets the `readme` target should call before generating the readme -export README_DEPS ?= docs/github-action.md - --include $(shell curl -sSL -o .build-harness "https://cloudposse.tools/build-harness"; echo .build-harness) - -## Lint terraform code -lint: - $(SELF) terraform/install terraform/get-modules terraform/get-plugins terraform/lint terraform/validate \ No newline at end of file diff --git a/README.yaml b/README.yaml index f4e9694..90a5acc 100644 --- a/README.yaml +++ b/README.yaml @@ -1,4 +1,3 @@ ---- # # This is the canonical configuration for the `README.md` # Run `make readme` to rebuild the `README.md` @@ -22,13 +21,17 @@ github_repo: cloudposse/github-action-yaml-config-query # Badges to display badges: - - name: "Latest Release" - image: "https://img.shields.io/github/release/cloudposse/github-action-yaml-config-query.svg" - url: "https://github.com/cloudposse/github-action-yaml-config-query/releases/latest" - - name: "Slack Community" - image: "https://slack.cloudposse.com/badge.svg" - url: "https://slack.cloudposse.com" - + - name: Latest Release + image: https://img.shields.io/github/release/cloudposse/github-action-yaml-config-query.svg?style=for-the-badge + url: https://github.com/cloudposse/github-action-yaml-config-query/releases/latest + - name: Last Updated + image: https://img.shields.io/github/last-commit/cloudposse/github-action-yaml-config-query.svg?style=for-the-badge + url: https://github.com/cloudposse/github-action-yaml-config-query/commits + - name: Slack Community + image: https://slack.cloudposse.com/for-the-badge.svg + url: https://cloudposse.com/slack + +# List any related terraform modules that this module may be used with or that this module depends on. related: [] # Short description of this project @@ -37,19 +40,19 @@ description: Define YAML document, filter it with JSON query and get result as o introduction: |- Utility action allow to declare YAML structured document as an input and get it's part as the action outputs referenced using JQ. - + This action is useful in simplifing complext GitHub action workflows in different ways. For examples follow [usage](#usage) section. - + ## Migration `v0` to `v1` - + There is an issue [The query contains `true` or `false` fails with an error](https://github.com/alexxander/jq-tools/issues/4). A workaround is to use a quote around `"true" and `"false" in a query. - + To migrate from `v0` to `v1`, quote in your queries all `true`/`false` and Github actions substitutions resovled to the values. - + ### Example - + * `query: .true` replace with `query: ."true"` * `query: .${{ inputs.from == '' }}` replace with `query: ."${{ inputs.from == '' }}"` @@ -82,7 +85,7 @@ usage: |- config: | image: acme/example tag: sha-${{ github.sha }} - + - run: | docker run ${{ steps.context.outputs.image }}:${{ steps.context.outputs.tag }} ``` @@ -111,7 +114,7 @@ usage: |- tag: ${{ github.sha }} false: tag: ${{ inputs.from }} - + - run: | docker tag acme/example:${{ steps.context.outputs.tag }} ``` @@ -185,10 +188,5 @@ usage: |- environment: ${{ matrix.environment }} ``` -include: - - "docs/github-action.md" - -# Contributors to this project -contributors: - - name: "Igor Rodionov" - github: "goruha" \ No newline at end of file +include: [] +contributors: [] diff --git a/atmos.yaml b/atmos.yaml new file mode 100644 index 0000000..dfa6aca --- /dev/null +++ b/atmos.yaml @@ -0,0 +1,2 @@ +import: + - https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/.github/atmos/github-action.yaml diff --git a/docs/github-action.md b/docs/github-action.md deleted file mode 100644 index 930749a..0000000 --- a/docs/github-action.md +++ /dev/null @@ -1,11 +0,0 @@ - - -## Inputs - -| Name | Description | Default | Required | -|------|-------------|---------|----------| -| config | YAML config | N/A | true | -| query | JQ Query | . | true | - - -