https://github.com/ecampidoglio/auto-release-milestone

:octocat::triangular_flag_on_post: Drafts a GitHub release based on a newly closed milestone.
https://github.com/ecampidoglio/auto-release-milestone

docker-action github-actions pluralsight release-automation release-notes

Last synced: 8 days ago
JSON representation

:octocat::triangular_flag_on_post: Drafts a GitHub release based on a newly closed milestone.

• Host: GitHub
• URL: https://github.com/ecampidoglio/auto-release-milestone
• Owner: ecampidoglio
• License: mit
• Created: 2020-01-11T15:07:45.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-02-15T12:20:38.000Z (almost 5 years ago)
• Last Synced: 2024-10-08T09:18:34.305Z (about 1 month ago)
• Topics: docker-action, github-actions, pluralsight, release-automation, release-notes
• Language: Shell
• Homepage: https://www.pluralsight.com/courses/building-custom-github-actions
• Size: 8.79 KB
• Stars: 13
• Watchers: 1
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Auto Release Milestone

A GitHub action that automatically drafts a GitHub release based on a newly closed milestone.

The issues that were closed as part of the milestone will be used as the basis to generate the release notes.

## Inputs

### `repo-token`

**(Required)** The `GITHUB_TOKEN` used to access the current repository from the GitHub REST API.

## Outputs

### `release-url`

The URL of the GitHub release that was drafted. Defaults to an empty string.

## Usage

Here's an example of a workflow that listens for the `milestone: closed` event and automatically creates a release draft with the issues that were closed as release notes. It also prints the URL of the release page to the build log.

```yaml

name: Test

on:

  milestone:

    types: [closed]

jobs:

  release:

    name: Release

    runs-on: ubuntu-latest

    steps:

      - name: Create a release draft for a milestone

        id: create-release-milestone

        uses: ecampidoglio/auto-release-milestone@v1

        with:

          repo-token: ${{ secrets.GITHUB_TOKEN }}

      - name: Print the URL of the release draft

        if: steps.create-release-milestone.outputs.release-url != ''

        run: echo ${{ steps.create-release-draft.outputs.release-url }}

```