Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/open-turo/action-major-release

GitHub Action: creates a floating branch for the major release
https://github.com/open-turo/action-major-release

action actions ci gha github major-release release release-major tool tooling tools

Last synced: about 11 hours ago
JSON representation

GitHub Action: creates a floating branch for the major release

Awesome Lists containing this project

README

        

# `open-turo/action-major-release`

## Description

GitHub Action that conditionally creates a floating branch for a major release

## Usage

### Execute the action to create/update the major release

In this case, a branch will be attempted to be created and pushed.

```yaml
steps:
- name: Major release
uses: open-turo/action-major-release@v1
with:
major-version: 1
```

### Execute the action in "dry run" mode

In this case, no branch will be created nor pushed. The commands that would be executed if not in dry run mode will be
sent to stdout.

```yaml
steps:
- name: Major release
uses: open-turo/action-major-release@v1
with:
major-version: 1
dry-run: true
```

## Inputs

| name | description | required | default |
| --- | --- | --- | --- |
| `major-version` |

The major version to publish. This will update the branch v<major-version> to the current git sha.

| `true` | `""` |
| `dry-run` |

Whether to run the action in dry-run mode - no branches will be created or pushed.

| `false` | `false` |

## Runs

This action is a `composite` action.