aevea / Release Notary
Projects that are alternatives of or similar to Release Notary
Release notary
Release Notary builds release notes using Conventional Commit standard and then publishes it to Github. Release notes are appended to any text you already have in your release and therefore will not affect important announcements etc.
Currently supported providers are: [Github, Gitlab].
Heavily inspired by https://github.com/graphql/graphql-js/releases, but usable as a standalone app.
Expected output is HERE
⚠️ Currently experimental. Please report any issues ⚠️
Table of contents
Setup
Github
Variables:
| Name | Example value | Required |
|---|---|---|
| GITHUB_TOKEN | token (provided in Github Action or HERE) | true |
| GITHUB_REPOSITORY | commitsar-app/commitsar | true |
In Github actions GITHUB_REPOSITORY is provided in the correct format. Does not need to be explicitly added.
In Github actions GITHUB_TOKEN is provided with the correct access rights, elsewhere it needs to be generated and added to the pipeline. Please see the usage section.
Gitlab
Variables:
In Gitlab CI all the values are provided except for GITLAB_TOKEN. Documentation provided here.
| Name | Example value | Required |
|---|---|---|
| GITLAB_TOKEN | token | true |
| CI_API_V4_URL | https://gitlab.com/api/v4 | true |
| CI_COMMIT_TAG | v0.0.4 | true |
| CI_PROJECT_ID | 1234 | true |
Slack
Slack integration posts release notes into Slack using the Incoming webhook integration. Slack Documentation
| Name | Example value | Required |
|---|---|---|
| SLACK_WEBHOOK | https://hooks.slack.com/services/something/something/something | false |
Usage
Using Github actions
actions/[email protected]
actions/[email protected] behaves differently from the first version. It pulls in just the latest commit and does not pull any other git objects. Release Notary needs these objects in order to work.
It should be run only on tags.
Example workflow file:
name: Release
on:
push:
tags:
- v*
jobs:
release-notes:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/[email protected]
with:
fetch-depth: 0
- name: Release Notary Action
uses: docker://aevea/release-notary:0.9.1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
actions/[email protected]
Should be run only on tags, example is HERE:
on:
push:
tags:
- "v*"
Checkout git in order to get commits and master branch
- name: Check out code into the Go module directory
uses: actions/[email protected]
Run the Release Notary action. Github token needs to be explicitly added so that Release Notary can use it. See https://help.github.com/en/articles/virtual-environments-for-github-actions
- name: Release Notary Action
uses: aevea/[email protected] (substitute for current version)
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Gitlab CI
release:
stage: release
variables:
GITLAB_TOKEN: $RELEASE_TOKEN
image: aevea/release-notary
script:
- release-notary publish
only:
- tags
Using binary
Download and run: (Substitute v0.0.2 for current version)
- curl -L -O https://github.com/aevea/release-notary/releases/download/v0.0.2/release-notary_v0.0.2_Linux_x86_64.tar.gz
- tar -xzf release-notary_v0.0.2_Linux_x86_64.tar.gz
# Set up any required variables
- export GITHUB_TOKEN=yourtoken
- export GITHUB_REPOSITORY=owner/repo
- ./release-notary publish