https://github.com/GeoWerkstatt/create-jira-release

Creates a new Jira release in your GitHub Actions workflow
https://github.com/GeoWerkstatt/create-jira-release

Last synced: about 1 month ago
JSON representation

Creates a new Jira release in your GitHub Actions workflow

• Host: GitHub
• URL: https://github.com/GeoWerkstatt/create-jira-release
• Owner: GeoWerkstatt
• License: mit
• Created: 2021-06-16T06:26:50.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-11T00:00:27.000Z (9 months ago)
• Last Synced: 2024-05-28T19:48:20.311Z (4 months ago)
• Size: 266 KB
• Stars: 23
• Watchers: 4
• Forks: 17
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# create-jira-release (GitHub Action)

[![Release](https://github.com/GeoWerkstatt/create-jira-release/actions/workflows/release-new-action-version.yml/badge.svg)](https://github.com/GeoWerkstatt/create-jira-release/actions/workflows/release-new-action-version.yml)

Creates a new Jira release for a specific Jira project and assigns all relevant* Jira issue numbers to it.  

\* All Jira issue numbers (e.g. TEST-123) in commit messages since last Git tag.

## Prerequisites

In order to be able to use this GitHub Action, a custom Jira automation rule needs to be created first. Please refer to the screenshot below for the most important settings.

![Setup Jira automation rule](./setup-jira-automation-rule.png)

## Usage

See [action.yml](action.yml)

```yaml

steps:

- uses: actions/checkout@v2

- uses: GeoWerkstatt/create-jira-release@v1

  with:

    jira-project-key: 'TEST'

    jira-automation-webhook: ${{ secrets.JIRA_AUTOMATION_WEBHOOK }}

    build-version: v${{ env.VERSION }}

```

## Options

| key                       | description                           | required |

| ------------------------- | ------------------------------------- | -------- |

| `jira-project-key`        | Jira project identifier (e.g. _TEST_) | true     |

| `jira-automation-webhook` | Jira automation webhook url           | true     |

| `build-version`           | Version identifier                    | true     |

## Secrets

| key                               | description                                                                                                         | required |

| --------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -------- |

| `secrets.JIRA_AUTOMATION_WEBHOOK` | Can be obtained or regenerated in the _Incoming webhook_ automation step of the corresponding Jira automation rule. | true     |

## Publish new GitHub Action version

A new GitHub _pre-release_ is created [automatically](./.github/workflows/create-new-pre-release.yml) if there are new changes on the `main` branch. Uncheck _This is a pre-release_ in the _Edit_-Section for a specific pre-release in order to [update](./.github/workflows/release-new-action-version.yml) a major tag (e.g. v1) to point to the latest release. A major tag from the latest released tag is created automatically if a corresponding major tag doesn't exist already.

## License

The scripts and documentation in this project are released under the [MIT License](LICENSE)