Skip to content

Commit a679bde

Browse files
authored
chore: Replace Makefile with atmos.yaml (#58)
1 parent 0768a1b commit a679bde

File tree

4 files changed

+23
-44
lines changed

4 files changed

+23
-44
lines changed

Makefile

Lines changed: 0 additions & 10 deletions
This file was deleted.

README.yaml

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
---
21
#
32
# This is the canonical configuration for the `README.md`
43
# Run `make readme` to rebuild the `README.md`
@@ -22,13 +21,17 @@ github_repo: cloudposse/github-action-yaml-config-query
2221

2322
# Badges to display
2423
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.
3235
related: []
3336

3437
# Short description of this project
@@ -37,19 +40,19 @@ description: Define YAML document, filter it with JSON query and get result as o
3740
introduction: |-
3841
Utility action allow to declare YAML structured document as an input and get it's part as the action outputs
3942
referenced using JQ.
40-
43+
4144
This action is useful in simplifing complext GitHub action workflows in different ways.
4245
For examples follow [usage](#usage) section.
43-
46+
4447
## Migration `v0` to `v1`
45-
48+
4649
There is an issue [The query contains `true` or `false` fails with an error](https://github.com/alexxander/jq-tools/issues/4).
4750
A workaround is to use a quote around `"true" and `"false" in a query.
48-
51+
4952
To migrate from `v0` to `v1`, quote in your queries all `true`/`false` and Github actions substitutions resovled to the values.
50-
53+
5154
### Example
52-
55+
5356
* `query: .true` replace with `query: ."true"`
5457
* `query: .${{ inputs.from == '' }}` replace with `query: ."${{ inputs.from == '' }}"`
5558
@@ -82,7 +85,7 @@ usage: |-
8285
config: |
8386
image: acme/example
8487
tag: sha-${{ github.sha }}
85-
88+
8689
- run: |
8790
docker run ${{ steps.context.outputs.image }}:${{ steps.context.outputs.tag }}
8891
```
@@ -111,7 +114,7 @@ usage: |-
111114
tag: ${{ github.sha }}
112115
false:
113116
tag: ${{ inputs.from }}
114-
117+
115118
- run: |
116119
docker tag acme/example:${{ steps.context.outputs.tag }}
117120
```
@@ -185,10 +188,5 @@ usage: |-
185188
environment: ${{ matrix.environment }}
186189
```
187190
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: []

atmos.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
import:
2+
- https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/.github/atmos/github-action.yaml

docs/github-action.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)