Release Process¶

using release-drafter/release-drafter for generate tagged release and generated release artefacts. This Action is part of the template Project nolte/cookiecutter-gh-project.

Usage¶

Two configurations must be created for use. The GitHub Workflow, and the Probot settings.

Workflow¶

---
name: Release Drafter

on:
  push:
    branches:
      - develop

jobs:
  update_release_draft:
    uses: nolte/gh-plumbing/.github/workflows/reusable-release-drafter.yml@v1.1.8
    secrets:
      token: ${{ secrets.GITHUB_TOKEN }}

(from .github/workflows/release-drafter.yml)

Probot¶

---
# These settings are synced to GitHub by https://probot.github.io/apps/release-drafter/

_extends: gh-plumbing:.github/commons-release-drafter.yml

(from .github/release-drafter.yml)

take a look to the release draft from this project:

Central Configuration¶

Workflow¶

The full Action configuration will be used from a central place.

name: Release Drafter

on:
  workflow_call:
    secrets:
      token:
        required: true

jobs:
  update_release_draft:
    name: Update Release Draft
    runs-on: ubuntu-latest
    steps:
      - uses: release-drafter/release-drafter@v6
        env:
          GITHUB_TOKEN: ${{ secrets.token }}

from .github/workflows/reusable-release-drafter.yml.

Probot¶

---
name-template: v$NEXT_PATCH_VERSION
tag-template: v$NEXT_PATCH_VERSION
branches:
  - master
  - develop
categories:
  - title: 🚀 Features
    label: enhancement
  - title: 🐛 Bug Fixes
    label: bug
  - title: 🧰 Maintenance
    labels:
      - "chore"
      - "documentations"
      - "project-config"
      - "cicd"
      - "dependencies"

template: |
  ## Changes

  $CHANGES

from .github/commons-release-drafter.yml.