Skip to content

Commit

Permalink
Add supported events section to readme
Browse files Browse the repository at this point in the history
Related: #19
  • Loading branch information
taiki-e committed Feb 16, 2023
1 parent 8c67bb6 commit 6f8df36
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ GitHub Action for creating GitHub Releases based on changelog.
- [Example workflow: No changelog](#example-workflow-no-changelog)
- [Example workflow: Reject releases from outside of main branch](#example-workflow-reject-releases-from-outside-of-main-branch)
- [Other examples](#other-examples)
- [Supported events](#supported-events)
- [Compatibility](#compatibility)
- [Related Projects](#related-projects)
- [License](#license)
Expand Down Expand Up @@ -211,6 +212,40 @@ jobs:
- [cargo-hack](https://github.com/taiki-e/cargo-hack/blob/202e6e59d491c9202ce148c9ef423853267226db/.github/workflows/release.yml#L25-L45)
- [tracing](https://github.com/tokio-rs/tracing/blob/2aa0cb010d8a7fa0de610413b5acd4557a00dd34/.github/workflows/release.yml#L10-L24)

## Supported events

The following two events are supported by default:

- tags ([`on.push.tags`](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#push))

For example:

```yaml
on:
push:
tags:
- v[0-9]+.*
```

- GitHub release ([`on.release`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#release))

For example:

```yaml
on:
release:
types: [created]
```

You can create a release from arbitrary event to arbitrary tag by specifying the `ref` input option.

For example, to create a release to the `my_tag` tag, specify `ref` input option as follows:

```yaml
with:
ref: refs/tags/my_tag
```

## Compatibility

This action has been tested for GitHub-hosted runners (Ubuntu, macOS, Windows).
Expand Down

0 comments on commit 6f8df36

Please sign in to comment.