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
10 changes: 0 additions & 10 deletions Makefile

This file was deleted.

44 changes: 21 additions & 23 deletions README.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
Expand All @@ -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
Expand All @@ -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 == '' }}"`

Expand Down Expand Up @@ -82,7 +85,7 @@ usage: |-
config: |
image: acme/example
tag: sha-${{ github.sha }}

- run: |
docker run ${{ steps.context.outputs.image }}:${{ steps.context.outputs.tag }}
```
Expand Down Expand Up @@ -111,7 +114,7 @@ usage: |-
tag: ${{ github.sha }}
false:
tag: ${{ inputs.from }}

- run: |
docker tag acme/example:${{ steps.context.outputs.tag }}
```
Expand Down Expand Up @@ -185,10 +188,5 @@ usage: |-
environment: ${{ matrix.environment }}
```

include:
- "docs/github-action.md"

# Contributors to this project
contributors:
- name: "Igor Rodionov"
github: "goruha"
include: []
contributors: []
2 changes: 2 additions & 0 deletions atmos.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
import:
- https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/.github/atmos/github-action.yaml
11 changes: 0 additions & 11 deletions docs/github-action.md

This file was deleted.

Loading