Skip to content

Commit 609bded

Browse files
authored
chore: Replace Makefile with atmos.yaml (#29)
1 parent 5a5958a commit 609bded

File tree

4 files changed

+24
-58
lines changed

4 files changed

+24
-58
lines changed

Makefile

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

README.yaml

Lines changed: 22 additions & 24 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`
@@ -23,13 +22,17 @@ github_repo: cloudposse/github-action-docker-promote
2322

2423
# Badges to display
2524
badges:
26-
- name: "Latest Release"
27-
image: "https://img.shields.io/github/release/cloudposse/github-action-docker-promote.svg"
28-
url: "https://github.com/cloudposse/github-action-docker-promote/releases/latest"
29-
- name: "Slack Community"
30-
image: "https://slack.cloudposse.com/badge.svg"
31-
url: "https://slack.cloudposse.com"
32-
25+
- name: Latest Release
26+
image: https://img.shields.io/github/release/cloudposse/github-action-docker-promote.svg?style=for-the-badge
27+
url: https://github.com/cloudposse/github-action-docker-promote/releases/latest
28+
- name: Last Updated
29+
image: https://img.shields.io/github/last-commit/cloudposse/github-action-docker-promote.svg?style=for-the-badge
30+
url: https://github.com/cloudposse/github-action-docker-promote/commits
31+
- name: Slack Community
32+
image: https://slack.cloudposse.com/for-the-badge.svg
33+
url: https://cloudposse.com/slack
34+
35+
# List any related terraform modules that this module may be used with or that this module depends on.
3336
related:
3437
- name: "github-action-docker-build-push"
3538
description: "Build Docker image and push it"
@@ -60,7 +63,7 @@ references:
6063
# How to use this project
6164
usage: |-
6265
### Promote a docker image to specific tag
63-
66+
6467
```yaml
6568
name: Release
6669
on:
@@ -87,17 +90,17 @@ usage: |-
8790
from: sha-${{ github.sha }}
8891
to: ${{ github.event.release.tag_name }}
8992
use_metadata: false
90-
93+
9194
outputs:
9295
image: ${{ steps.promote.outputs.image }}
9396
tag: ${{ steps.promote.outputs.tag }}
9497
```
9598
9699
### Promote a docker image to tags detected from metadata
97-
100+
98101
Promote action use [Docker Metadata action](https://github.com/marketplace/actions/docker-metadata-action) under the
99102
hood and can detect `to` tags based on Git reference and GitHub events.
100-
103+
101104
```yaml
102105
name: Pull Request
103106
on:
@@ -109,12 +112,12 @@ usage: |-
109112
context:
110113
runs-on: ubuntu-latest
111114
steps:
112-
115+
113116
- name: Checkout
114117
uses: actions/checkout@v3
115118
with:
116119
fetch-depth: 2
117-
120+
118121
- name: Get previous commit
119122
id: prev-commit
120123
run: echo "sha=$(git rev-parse --verify HEAD^1)" >> $GITHUB_OUTPUT
@@ -130,7 +133,7 @@ usage: |-
130133
password: ${{ secrets.DOCKERHUB_PASSWORD }}
131134
from: sha-${{ steps.prev-commit.outputs.sha }}
132135
use_metadata: true
133-
136+
134137
outputs:
135138
image: ${{ steps.promote.outputs.image }}
136139
tag: ${{ steps.promote.outputs.tag }}
@@ -139,7 +142,7 @@ usage: |-
139142
### Promote a docker image with `from` fetched from metadata
140143
141144
If you skip `from` tag then it would be populated as SHA of the current commit in long format.
142-
145+
143146
```yaml
144147
name: Release
145148
on:
@@ -156,7 +159,7 @@ usage: |-
156159
steps:
157160
- name: Checkout
158161
uses: actions/checkout@v3
159-
162+
160163
- name: Docker image promote
161164
uses: cloudposse/github-action-docker-promote@main
162165
id: promote
@@ -175,10 +178,5 @@ usage: |-
175178
tag: ${{ steps.promote.outputs.tag }}
176179
```
177180
178-
include:
179-
- "docs/github-action.md"
180-
181-
# Contributors to this project
182-
contributors:
183-
- name: "Igor Rodionov"
184-
github: "goruha"
181+
include: []
182+
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 & 24 deletions
This file was deleted.

0 commit comments

Comments
 (0)