1
- ---
2
1
#
3
2
# This is the canonical configuration for the `README.md`
4
3
# Run `make readme` to rebuild the `README.md`
@@ -22,13 +21,17 @@ github_repo: cloudposse/github-action-yaml-config-query
22
21
23
22
# Badges to display
24
23
badges :
25
- - name : " Latest Release"
26
- image : " https://img.shields.io/github/release/cloudposse/github-action-yaml-config-query.svg"
27
- url : " https://github.com/cloudposse/github-action-yaml-config-query/releases/latest"
28
- - name : " Slack Community"
29
- image : " https://slack.cloudposse.com/badge.svg"
30
- url : " https://slack.cloudposse.com"
31
-
24
+ - name : Latest Release
25
+ image : https://img.shields.io/github/release/cloudposse/github-action-yaml-config-query.svg?style=for-the-badge
26
+ url : https://github.com/cloudposse/github-action-yaml-config-query/releases/latest
27
+ - name : Last Updated
28
+ image : https://img.shields.io/github/last-commit/cloudposse/github-action-yaml-config-query.svg?style=for-the-badge
29
+ url : https://github.com/cloudposse/github-action-yaml-config-query/commits
30
+ - name : Slack Community
31
+ image : https://slack.cloudposse.com/for-the-badge.svg
32
+ url : https://cloudposse.com/slack
33
+
34
+ # List any related terraform modules that this module may be used with or that this module depends on.
32
35
related : []
33
36
34
37
# Short description of this project
@@ -37,19 +40,19 @@ description: Define YAML document, filter it with JSON query and get result as o
37
40
introduction : |-
38
41
Utility action allow to declare YAML structured document as an input and get it's part as the action outputs
39
42
referenced using JQ.
40
-
43
+
41
44
This action is useful in simplifing complext GitHub action workflows in different ways.
42
45
For examples follow [usage](#usage) section.
43
-
46
+
44
47
## Migration `v0` to `v1`
45
-
48
+
46
49
There is an issue [The query contains `true` or `false` fails with an error](https://github.com/alexxander/jq-tools/issues/4).
47
50
A workaround is to use a quote around `"true" and `"false" in a query.
48
-
51
+
49
52
To migrate from `v0` to `v1`, quote in your queries all `true`/`false` and Github actions substitutions resovled to the values.
50
-
53
+
51
54
### Example
52
-
55
+
53
56
* `query: .true` replace with `query: ."true"`
54
57
* `query: .${{ inputs.from == '' }}` replace with `query: ."${{ inputs.from == '' }}"`
55
58
@@ -82,7 +85,7 @@ usage: |-
82
85
config: |
83
86
image: acme/example
84
87
tag: sha-${{ github.sha }}
85
-
88
+
86
89
- run: |
87
90
docker run ${{ steps.context.outputs.image }}:${{ steps.context.outputs.tag }}
88
91
```
@@ -111,7 +114,7 @@ usage: |-
111
114
tag: ${{ github.sha }}
112
115
false:
113
116
tag: ${{ inputs.from }}
114
-
117
+
115
118
- run: |
116
119
docker tag acme/example:${{ steps.context.outputs.tag }}
117
120
```
@@ -185,10 +188,5 @@ usage: |-
185
188
environment: ${{ matrix.environment }}
186
189
```
187
190
188
- include :
189
- - " docs/github-action.md"
190
-
191
- # Contributors to this project
192
- contributors :
193
- - name : " Igor Rodionov"
194
- github : " goruha"
191
+ include : []
192
+ contributors : []
0 commit comments