{"id":24629468,"url":"https://github.com/aevea/release-notary","last_synced_at":"2025-05-07T22:13:45.103Z","repository":{"id":37035375,"uuid":"192496983","full_name":"aevea/release-notary","owner":"aevea","description":"App to just generate release notes.","archived":false,"fork":false,"pushed_at":"2025-05-07T12:45:04.000Z","size":298,"stargazers_count":34,"open_issues_count":23,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-07T13:45:53.744Z","etag":null,"topics":["ci","gitlab","golang","release-notes"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aevea.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-06-18T08:19:26.000Z","updated_at":"2023-08-17T22:35:17.000Z","dependencies_parsed_at":"2023-10-10T21:57:04.547Z","dependency_job_id":"d7b7a775-cdb6-4429-a144-8dc51e6cea05","html_url":"https://github.com/aevea/release-notary","commit_stats":{"total_commits":308,"total_committers":11,"mean_commits":28.0,"dds":0.4675324675324676,"last_synced_commit":"250ecbda19d73268c3c62e9863c1010773b3345e"},"previous_names":["fallion/release-notary","commitsar-app/release-notary","outillage/release-notary"],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aevea%2Frelease-notary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aevea%2Frelease-notary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aevea%2Frelease-notary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aevea%2Frelease-notary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aevea","download_url":"https://codeload.github.com/aevea/release-notary/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252892007,"owners_count":21820638,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ci","gitlab","golang","release-notes"],"created_at":"2025-01-25T06:12:58.792Z","updated_at":"2025-05-07T22:13:45.082Z","avatar_url":"https://github.com/aevea.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Release notary\n\n![Test](https://github.com/aevea/release-notary/workflows/Test/badge.svg)\n![GitHub release (latest by date)](https://img.shields.io/github/v/release/aevea/release-notary?style=flat-square)\n![GitHub commits since latest release](https://img.shields.io/github/commits-since/aevea/release-notary/latest?style=flat-square)\n\nRelease 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.\n\nCurrently supported providers are: `[Github, Gitlab]`.\n\nHeavily inspired by https://github.com/graphql/graphql-js/releases, but usable as a standalone app.\n\nExpected output is [HERE](./expected-output.md)\n\n:warning: **Currently experimental. Please report any issues** :warning:\n\n### Table of contents\n\n1. [Setup](#setup)\n   - [Github](#github)\n   - [Gitlab](#gitlab)\n   - [Slack](#slack)\n2. [Usage](#usage)\n\n## Setup\n\n### Github\n\n**Variables:**\n\n| Name              | Example value                                                                                                                          | Required |\n| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------- |\n| 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     |\n| GITHUB_REPOSITORY | commitsar-app/commitsar                                                                                                                | true     |\n\nIn Github actions GITHUB_REPOSITORY is provided in the correct format. Does not need to be explicitly added.\n\nIn 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.\n\n### Gitlab\n\n**Variables:**\n\nIn Gitlab CI all the values are provided except for `GITLAB_TOKEN`. Documentation provided [here](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html).\n\n| Name          | Example value             | Required |\n| ------------- | ------------------------- | -------- |\n| GITLAB_TOKEN  | token                     | true     |\n| CI_API_V4_URL | https://gitlab.com/api/v4 | true     |\n| CI_COMMIT_TAG | v0.0.4                    | true     |\n| CI_PROJECT_ID | 1234                      | true     |\n\n### Slack\n\nSlack integration posts release notes into Slack using the `Incoming webhook` integration. [Slack Documentation](https://api.slack.com/messaging/webhooks)\n\n| Name          | Example value                                                  | Required |\n| ------------- | -------------------------------------------------------------- | -------- |\n| SLACK_WEBHOOK | https://hooks.slack.com/services/something/something/something | false    |\n\n## Usage\n\n#### Using Github actions\n\n##### actions/checkout@v2\n\nactions/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.\n\nIt should be run only on tags.\n\nExample workflow file:\n\n```yaml\nname: Release\non:\n  push:\n    tags:\n      - v*\njobs:\n  release-notes:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v2\n        with:\n          fetch-depth: 0\n      - name: Release Notary Action\n        uses: docker://aevea/release-notary:0.9.1\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n```\n\n##### actions/checkout@v1\n\nShould be run only on tags, example is [HERE](https://github.com/aevea/commitsar/blob/master/.github/workflows/release.yml):\n\n```yml\non:\n  push:\n    tags:\n      - \"v*\"\n```\n\nCheckout git in order to get commits and master branch\n\n```yml\n- name: Check out code into the Go module directory\n  uses: actions/checkout@v1\n```\n\nRun 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\n\n```yml\n- name: Release Notary Action\n  uses: aevea/release-notary@v0.2.0 (substitute for current version)\n  env:\n    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n```\n\n#### Gitlab CI\n\n```yml\nrelease:\n  stage: release\n  variables:\n    GITLAB_TOKEN: $RELEASE_TOKEN\n  image:\n    name: aevea/release-notary:latest\n    entrypoint: [\"\"]\n  script:\n    - release-notary publish\n  only:\n    - tags\n```\n\n#### Using binary\n\nDownload and run: **(Substitute v0.0.2 for current version)**\n\n```yml\n- curl -L -O https://github.com/aevea/release-notary/releases/download/v0.0.2/release-notary_v0.0.2_Linux_x86_64.tar.gz\n- tar -xzf release-notary_v0.0.2_Linux_x86_64.tar.gz\n# Set up any required variables\n- export GITHUB_TOKEN=yourtoken\n- export GITHUB_REPOSITORY=owner/repo\n- ./release-notary publish\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faevea%2Frelease-notary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faevea%2Frelease-notary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faevea%2Frelease-notary/lists"}