Tag n' Slack

Creates a new Tag with a Changelog from either:

• CHANGELOG.md using the version from package.json
• commit hash and message

and notifies Slack about the release.

Screenshot

Usage

Here's an example on how to use the action:

.github/workflows/release.yml

on:
    push:
        branches:
            - main

jobs:
    release:
        name: Release
        runs-on: ubuntu-latest
        steps:
            - name: Checkout
              uses: actions/checkout@v2
            - name: Tag n' Slack
              id: tag-n-slack
              uses: perspective-software/[email protected]
              with:
                  github-access-token: ${{ github.token }}
                  slack-webhook-url: ${{ secrets.SLACK_WEBHOOK_RELEASE }}
                  slack-release-link: 'https://github.com/...'
                  slack-icon-emoji: ':zap:'
                  project-name: ${{ github.event.repository.name }}
                  project-owner: ${{ github.event.repository.owner.login }}
                  version-increment-strategy: 'github-releases'
                  target-commitish: 'main'
                  remove-images: ${{ github.event.repository.private }}
                  ticket-config: '{  
                    "ticketPrefixes": ["CON", "FUN", "GRO"], 
                    "ticketUrlTemplate": "https://linear.app/XXX/issue/{ticket}",
                  }'

• github-access-token (required) is automatically created during the workflow and only valid for this one workflow. Nothing to do here.
• slack-webhook-url (required) is your Slack Webhook URL defined in your Github Action's secrets. You can create a Slack webhook here.
• slack-release-link (required) is the link to your project.
• slack-icon-emoji (optional, default = :rocket:) is the Emoji next to the Slack message. Can also be one of your workspaces custom emojis.
• project-name (optional, default = ${{github.event.repository.name}}) is the name of your project.
• project-owner (required when version-increment-strategy is github-releases), it's the project owner's handle
• version-increment-strategy (optional, default = changelog-file, valid options = changelog-file or github-releases). changelog-file strategy retrieves the version from package.json and the release message from CHANGELOG.md. github-releases strategy retrieves the version and message from the merge commit. The version is the 7-digit hash, and the message is the commit message. It is recommended to use this strategy with "Squash and Merge" in your PRs, where the PR title and description become the commit message.
• target-commitish (optional, default = main) is used when version-increment-strategy is github-releases, it's the project's main branch name.
• remove-images (optional, default = Github repo private (true) or public(false)) is a boolean to remove images and Github user attachments from the Slack message. For private repositories this should be enabled, since the user attachments (including images) will only be accessible by people with access to the repository.
• ticket-config (optional) is a JSON string with the following properties:
  • ticketPrefixes (optional, default = []) is an array of ticket prefixes to search for in the commit message. If a ticket prefix is found, it will be included in the Slack message.
  • ticketUrlTemplate (optional, default = '') is a template string to create a link to the ticket. The template should include {ticket} as a placeholder for the ticket number. If a ticket prefix is found in the commit message, the ticket number will be inserted into the template to create a link.

How it works

When version-increment-strategy is changelog-file, it's using gh-release under the hood that parses your package.json and CHANGELOG.md for a version number. If it finds a matching version, it's extracting the latest text from the CHANGELOG.md, creates a new Github tag and uses the text as the body.

If the versions don't match or a Tag with that version already exists, this action won't create a new tag and won't notify Slack.

When version-increment-strategy is github-releases, it retrieves the version and message from the merge commit. The version is the 7-digit hash, and the message is the commit message. It is recommended to use this strategy with "Squash and Merge" in your PRs, where the PR title and description become the commit message.

As an example, this action will create the Slack notification seen above:

Features

Markdown Conversion

Headings (from # to ####), lists, links and more are converted into Slack-friendly mrkdwn. Thanks to @tryfabric/mack

Example: ## Description becomes *Description* and - Item becomes • Item.

Ticket Links

Ticket IDs are automatically replaced with clickable links using a configurable URL template.

Example:

PER-1234 becomes [PER-1234](https://linear.app/perspective/issue/PER-1234)

If no ticket configuration is provided, ticket IDs remain unchanged.

Development

Make adjustments as required in the src directory and run npm run build to compile it to action/index.js (dist) before commiting and pushing.