-
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathREADME.yaml
80 lines (66 loc) · 3.64 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
---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#
# Name of this project
name: GitHub Action Auto-release
# License of this project
license: "APACHE2"
# Copyrights
copyrights:
- name: "Cloud Posse, LLC"
url: "https://cloudposse.com"
year: "2022"
# Canonical GitHub repo
github_repo: cloudposse/github-action-auto-release
# Badges to display
badges:
- name: "Latest Release"
image: "https://img.shields.io/github/release/cloudposse/github-action-auto-release.svg"
url: "https://github.com/cloudposse/github-action-auto-release/releases/latest"
- name: "Slack Community"
image: "https://slack.cloudposse.com/badge.svg"
url: "https://slack.cloudposse.com"
related:
- name: "GitHub Action Auto-format"
description: "Add standard files to a repo and keep its README up to date"
url: "https://github.com/cloudposse/github-action-auto-format"
- name: "GitHub Action Terraform Auto-context"
description: "Automatically update `context.tf` whenever a new version becomes available"
url: "https://github.com/cloudposse/github-action-terraform-auto-context"
- name: "GitHub Action Terraform CI"
description: "Full suite of Terraform CI actions, along with chatops support"
url: "https://github.com/cloudposse/github-action-terraform-ci"
- name: "GitHub Action Validate CODEOWNERS"
description: "Validate and lint contents of CODEOWNERS file"
url: "https://github.com/cloudposse/github-action-validate-codeowners"
include:
- "docs/github-action.md"
# References
references:
- name: "Release Drafter"
description: 'Drafts your next release notes as pull requests are merged into master'
url: "https://github.com/release-drafter/release-drafter"
# Short description of this project
description: |-
This is an opinionated composite Github Action that implements a workflow based on the popular `release-drafter` action to automatically draft releases with release notes that are derived from PR descriptions as they are merged into the default branch. ```
Under default settings, `auto-release` will also cut a new release from the default branch after every merge into it. However, releases are not cut for merges of pull requests with a `no-release` label attached. In that case, the release notes are left as a draft and a release with all unreleased changes will be made the next time a pull request without the `no-release` label is merged into the default branch.
# How to use this project
usage: |-
Copy the `.github/workflows/auto-release.yml` and `.github/configs/release-drafter.yml` files from this repository into the corresponding folders of the repository to which you'd like to add Auto-release functionality.
This will trigger the `auto-release` functionality every time merges are made into the default branch.
# Example usage
examples: |-
Here's a real world example:
- [`github-action-auto-release`](https://github.com/cloudposse/github-action-auto-release/.github/workflows/auto-release.yml) - The self-testing Cloud Posse Auto-format GitHub Action
# How to get started quickly
quickstart: |-
Here's how to get started...
1. Copy the `.github/workflows/auto-release.yml` github action workflow from this repository into the corresponding folder of the target repo
2. Copy the `.github/configs/release-drafter.yml` auto-release config file from this repository into the corresponding folder of the target repo
3. Customize the config file as desired, per the [config documentation](https://github.com/release-drafter/release-drafter#configuration)
# Contributors to this project
contributors:
- name: "Dylan Bannon"
github: "dylanbannon"