Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aevea/release-notary
App to just generate release notes.
https://github.com/aevea/release-notary
ci gitlab golang release-notes
Last synced: 1 day ago
JSON representation
App to just generate release notes.
- Host: GitHub
- URL: https://github.com/aevea/release-notary
- Owner: aevea
- License: mit
- Created: 2019-06-18T08:19:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-01-16T20:39:23.000Z (10 days ago)
- Last Synced: 2025-01-16T21:40:05.250Z (10 days ago)
- Topics: ci, gitlab, golang, release-notes
- Language: Go
- Homepage:
- Size: 316 KB
- Stars: 34
- Watchers: 2
- Forks: 3
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Release notary
Release Notary builds release notes using [Conventional Commit](https://www.conventionalcommits.org/) 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](./expected-output.md)
:warning: **Currently experimental. Please report any issues** :warning:
### Table of contents
1. [Setup](#setup)
- [Github](#github)
- [Gitlab](#gitlab)
- [Slack](#slack)
2. [Usage](#usage)
## Setup
### Github
**Variables:**
| Name | Example value | Required |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| GITHUB_TOKEN | token (provided in Github Action or [HERE](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line)) | 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](#usage) section.
### Gitlab
**Variables:**
In Gitlab CI all the values are provided except for `GITLAB_TOKEN`. Documentation provided [here](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html).
| 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](https://api.slack.com/messaging/webhooks)
| Name | Example value | Required |
| ------------- | -------------------------------------------------------------- | -------- |
| SLACK_WEBHOOK | https://hooks.slack.com/services/something/something/something | false |
## Usage
#### Using Github actions
##### actions/checkout@v2
actions/checkout@v2 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:
```yaml
name: Release
on:
push:
tags:
- v*
jobs:
release-notes:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Release Notary Action
uses: docker://aevea/release-notary:0.9.1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
##### actions/checkout@v1
Should be run only on tags, example is [HERE](https://github.com/aevea/commitsar/blob/master/.github/workflows/release.yml):
```yml
on:
push:
tags:
- "v*"
```
Checkout git in order to get commits and master branch
```yml
- name: Check out code into the Go module directory
uses: actions/checkout@v1
```
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
```yml
- name: Release Notary Action
uses: aevea/[email protected] (substitute for current version)
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
#### Gitlab CI
```yml
release:
stage: release
variables:
GITLAB_TOKEN: $RELEASE_TOKEN
image:
name: aevea/release-notary:latest
entrypoint: [""]
script:
- release-notary publish
only:
- tags
```
#### Using binary
Download and run: **(Substitute v0.0.2 for current version)**
```yml
- 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
```