Skip to content

Commit a923db6

Browse files
committed
chore: update README.md
1 parent 062f747 commit a923db6

File tree

2 files changed

+17
-4
lines changed

2 files changed

+17
-4
lines changed

.github/banner.png

35.3 KB
Loading

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11

22

33
<!-- markdownlint-disable -->
4-
# github-action-yaml-config-query <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/github-action-yaml-config-query&utm_content="><img align="right" src="https://cloudposse.com/logo-300x69.svg" width="150" /></a>
5-
<a href="https://github.com/cloudposse/github-action-yaml-config-query/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/github-action-yaml-config-query.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a>
4+
<a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse/github-action-yaml-config-query/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/>
5+
<p align="right">
6+
<a href="https://github.com/cloudposse/github-action-yaml-config-query/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/github-action-yaml-config-query.svg" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/badge.svg" alt="Slack Community"/></a></p>
67
<!-- markdownlint-restore -->
78

89
<!--
@@ -37,7 +38,19 @@ Utility action allow to declare YAML structured document as an input and get it'
3738
referenced using JQ.
3839

3940
This action is useful in simplifing complext GitHub action workflows in different ways.
40-
For examples follow [usage](#usage) section.
41+
For examples follow [usage](#usage) section.
42+
43+
## Migration `v0` to `v1`
44+
45+
There is an issue [The query contains `true` or `false` fails with an error](https://github.com/alexxander/jq-tools/issues/4).
46+
A workaround is to use a quote around `"true" and `"false" in a query.
47+
48+
To migrate from `v0` to `v1`, quote in your queries all `true`/`false` and Github actions substitutions resovled to the values.
49+
50+
### Example
51+
52+
* `query: .true` replace with `query: ."true"`
53+
* `query: .${{ inputs.from == '' }}` replace with `query: ."${{ inputs.from == '' }}"`
4154

4255

4356

@@ -86,7 +99,7 @@ For examples follow [usage](#usage) section.
8699
id: from
87100
uses: cloudposse/github-action-yaml-config-query@main
88101
with:
89-
query: .${{ inputs.from == '' }}
102+
query: ."${{ inputs.from == '' }}"
90103
config: |-
91104
true:
92105
tag: ${{ github.sha }}

0 commit comments

Comments
 (0)