https://github.com/dolittle/create-release-notes-action

https://github.com/dolittle/create-release-notes-action

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/dolittle/create-release-notes-action
• Owner: dolittle
• License: mit
• Created: 2021-10-25T16:05:25.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-12-07T15:19:36.000Z (over 2 years ago)
• Last Synced: 2025-01-01T09:10:29.704Z (5 months ago)
• Language: TypeScript
• Size: 145 KB
• Stars: 0
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHub Action - Create Release Notes

This GitHub action creates release notes from a release summary (usually a Pull Request body) formatted

like [this template](.github/PULL_REQUEST_TEMPLATE.md). The output can be used for packages published to

e.g. NuGet.

![Github JavaScript Actions CI/CD](https://github.com/dolittle/create-release-notes-action/workflows/Github%20JavaScript%20Actions%20CI/CD/badge.svg)

### Pre requisites

Create a workflow `.yml` file in your `.github/workflows` directory. An [example workflow](#example-workflow) is available below.

For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file)

### Inputs

- `body` (required): The body of the release summary. Recommended format [PULL_REQUEST_TEMPLATE.md](.github/PULL_REQUEST_TEMPLATE.md).

- `version` (required): The version released.

- `changelog-url`: If provided, a link to this URL will be appended to the bottom of the release notes.

### Outputs

- `markdown`: Release notes formatted as Markdown

- `plaintext`: Release notes formatted as plain text

### Example Workflow

```yaml

on:

  push:

    branches:

    - '**'

  pull_request:

    types: [closed]

name: GitHub action workflow name

jobs:

  context:

    name: Job name

    runs-on: ubuntu-latest

    steps:

      - name: Checkout code

        uses: actions/checkout@v2

      - name: Establish context

        id: context

        uses: dolittle/establish-context-action@v2

      - name: Increment version

        id: increment-version

        uses: dolittle/increment-version-action@v2

        with:

          version: ${{ steps.context.outputs.current-version }}

          release-type: ${{ steps.context.outputs.release-type }}

      - name: Create release notes

        uses: dolittle/create-release-notes-action@v1

        with:

          body: ${{ steps.context.outputs.pr-body }}

          version: ${{ steps.increment-version.outputs.next-version }}

          changelog-url: "https://github.com/dolittle/create-release-notes-action/blob/master/CHANGELOG.md"

        

```

## Contributing

We're always open for contributions and bug fixes!

### Pre requisites

node <= 12

yarn

git