-
-
Notifications
You must be signed in to change notification settings - Fork 3
/
README.yaml
112 lines (88 loc) · 3.05 KB
/
README.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#
# Name of this project
name: github-action-setup-atmos
# Tags of this project
tags:
- github-action
- atmos
# Logo for this project
#logo: docs/logo.png
# License of this project
license: "APACHE2"
# Canonical GitHub repo
github_repo: cloudposse/github-action-setup-atmos
# Badges to display
badges:
- name: "Latest Release"
image: "https://img.shields.io/github/release/cloudposse/github-action-setup-atmos.svg"
url: "https://github.com/cloudposse/github-action-setup-atmos/releases/latest"
- name: "Slack Community"
image: "https://slack.cloudposse.com/badge.svg"
url: "https://slack.cloudposse.com"
related: []
# Short description of this project
description: Install atmos for use in GitHub Actions
introduction: |-
This repo contains a GitHub Action to setup [atmos](https://github.com/cloudposse/atmos) for use in GitHub Actions. It
installs the specified version of atmos and adds it to the `PATH` so it can be used in subsequent steps. In addition,
it optionally installs a wrapper script that will capture the `stdout`, `stderr`, and `exitcode` of the `atmos`
command and make them available to subsequent steps via outputs of the same name.
references:
- name: "github-actions-workflows"
description: "Reusable workflows for different types of projects"
url: "https://github.com/cloudposse/github-actions-workflows"
- name: "example-github-action-release-workflow"
description: "Example application with complicated release workflow"
url: "https://github.com/cloudposse/example-github-action-release-workflow"
# How to use this project
usage: |-
```yaml
steps:
- uses: hashicorp/setup-terraform@v2
- name: Setup atmos
uses: cloudposse/github-action-setup-atmos@v2
````
To install a specific version of atmos, set the `version` input:
```yaml
steps:
- uses: hashicorp/setup-terraform@v2
- name: Setup atmos
uses: cloudposse/github-action-setup-atmos@v2
with:
version: 0.15.0
````
The wrapper script installation can be skipped by setting the `install-wrapper` input to `false`:
```yaml
steps:
- uses: hashicorp/setup-terraform@v2
- name: Setup atmos
uses: cloudposse/github-action-setup-atmos@v2
with:
install-wrapper: false
````
Subsequent steps of the GitHub action can use the wrapper scipt to capture the `stdout`, `stderr`, and `exitcode` if
the wrapper script was installed:
```yaml
steps:
- uses: hashicorp/setup-terraform@v2
- name: Setup atmos
uses: cloudposse/github-action-setup-atmos@v2
with:
install-wrapper: true
- name: Run atmos
id: atmos
run: atmos terraform plan
- run: echo ${{ steps.atmos.outputs.stdout }}
- run: echo ${{ steps.atmos.outputs.stderr }}
- run: echo ${{ steps.atmos.outputs.exitcode }}
```
include:
- "docs/github-action.md"
# Contributors to this project
contributors:
- name: "Matt Calhoun"
github: "mcalhoun"