catkin-release-action's Introduction

catkin-release-action

GitHub Action to create a ROS package release candidate branch.

Inputs

github_token: GITHUB_TOKEN. (required)
version: New package version. One of version and issue_title must be specified.
issue_title: Issue title containing new package version. One of version and issue_title must be specified.
git_user: User name of commit author. (required)
git_email: E-mail address of commit author. (required)

Outputs

created_branch: Created branch of the release candidate.
version: Created release version.

Example

Following example creates a release candidate branch with CHANGELOG.rst and open a pull-request.

name: release-candidate
on:
  issues:
    types: [opened]

jobs:
  release-candidate:
    runs-on: ubuntu-latest
    if: startsWith(github.event.issue.title, 'Release ')
    steps:
      - name: checkout
        uses: actions/checkout@v2
      - name: create release
        id: create_release
        uses: at-wat/catkin-release-action@v1
        with:
          issue_title: ${{ github.event.issue.title }}
          git_user: @@MAINTAINER_LOGIN@@
          git_email: @@MAINTAINER_EMAIL_ADDRESS@@
          github_token: ${{ secrets.GITHUB_TOKEN }}
      - name: open pull-request
        uses: repo-sync/pull-request@v2
        with:
          source_branch: ${{ steps.create_release.outputs.created_branch }}
          destination_branch: master
          pr_title: Release ${{ steps.create_release.outputs.version}}
          pr_body: close \#${{ github.event.issue.number }}
          github_token: ${{ secrets.GITHUB_TOKEN }}