An open API service indexing awesome lists of open source software.

https://github.com/open-turo/actions-release

GitHub Actions for handling releases
https://github.com/open-turo/actions-release

action actions gha github release semantic-release semver

Last synced: about 2 months ago
JSON representation

GitHub Actions for handling releases

Awesome Lists containing this project

README

          

# `open-turo/actions-release`

GitHub Actions for handling releases.

[![Release](https://img.shields.io/github/v/release/open-turo/actions-release)](https://github.com/open-turo/actions-release/releases/)
[![Tests pass/fail](https://img.shields.io/github/workflow/status/open-turo/actions-release/CI)](https://github.com/open-turo/actions-release/actions/)
[![License](https://img.shields.io/github/license/open-turo/actions-release)](./LICENSE)
[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](https://github.com/dwyl/esta/issues)
![CI](https://github.com/open-turo/actions-release/actions/workflows/release.yaml/badge.svg)
[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
[![Conventional commits](https://img.shields.io/badge/conventional%20commits-1.0.2-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
[![Join us!](https://img.shields.io/badge/Turo-Join%20us%21-593CFB.svg)](https://turo.com/jobs)

## Actions

### action: [`lint-release-notes`](./lint-release-notes)

Automatically generate release notes using semantic-release and post them as a comment in a pull request with the
changes that would be included in the next version of the codebase if the pull request is merged.

See usage [here](lint-release-notes/README.md#usage).

Documentation is found [here](lint-release-notes/README.md).

### action: [`semantic-release`](./semantic-release)

GitHub Action for Semantic Release

See usage [here](semantic-release/README.md#usage).

Documentation is found [here](semantic-release/README.md).

## Get Help

Each Action has a detailed README for how to use it as referenced above. Please review Issues, post new Issues against
this repository as needed.

## Contributions

Please see [here](https://github.com/open-turo/contributions) for guidelines on how to contribute to this project.

## Development

### Documentation

We are using [`action-docs`](https://github.com/npalm/action-docs) to keep our action documentation up to date. This is
handled by a script that uses `npx` to run action-lint. To update documentation manually, run:

```shell
pre-commit run -a update-action-readme
```