release.yml

# Creates the GitHub Release page for a version tag.
#
# The notes are composed by the shared workflow in
# imqueue/.github/.github/workflows/release.yml: a CHANGELOG.md section for the exact
# version when one exists, otherwise GitHub's PR-derived notes, always followed by a
# standard About + links block.
#
# This fires on `git push --follow-tags` after `npm version`, so it needs no change to
# the existing release habit. workflow_dispatch is for backfilling a tag that already
# exists, and defaults to a dry run so the notes can be read before anything is created.

name: Release

on:
  push:
    tags: ['v*']
  workflow_dispatch:
    inputs:
      tag:
        description: 'Existing tag to compose notes for, e.g. v1.2.3'
        required: true
        type: string
      dry-run:
        description: 'Only print the notes; do not create or update the release'
        required: false
        type: boolean
        default: true

jobs:
  release:
    uses: imqueue/.github/.github/workflows/release.yml@master
    # A called workflow can hold no more permission than its caller grants, so this is
    # required even though the shared workflow declares it too.
    permissions:
      contents: write
    with:
      package: '@imqueue/pg-sequelize'
      tag: ${{ inputs.tag || '' }}
      dry-run: ${{ inputs.dry-run || false }}
      blurb: >-
        `@imqueue/pg-sequelize` turns a query described as data — filters, paging, ordering and the
        requested fields — into one efficient Sequelize statement, with database views as models
        and the Postgres index options Sequelize cannot express. Part of the @imqueue framework
        for Node.js & TypeScript microservices.