https://github.com/dhis2/action-semantic-release

https://github.com/dhis2/action-semantic-release

action synced-settings

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/dhis2/action-semantic-release
• Owner: dhis2
• Created: 2021-07-02T08:32:46.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-08-08T16:03:06.000Z (3 months ago)
• Last Synced: 2024-10-08T21:46:53.781Z (about 1 month ago)
• Topics: action, synced-settings
• Language: JavaScript
• Size: 1020 KB
• Stars: 2
• Watchers: 24
• Forks: 0
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Support: support/getWorkspacePackages.js

Awesome Lists containing this project

README

        
# semantic-release

GitHub Action to run

[**semantic-release**](https://github.com/semantic-release/semantic-release/) with

the DHIS2 customizations and extensions in place.

In addition to the ready-made **semantic-release** plugins:

-   [commit-analyzer](https://github.com/semantic-release/commit-analyzer)

-   [release-notes-generator](https://github.com/semantic-release/release-notes-generator)

-   [changelog](https://github.com/semantic-release/changelog)

-   [npm](https://github.com/semantic-release/npm)

-   [git](https://github.com/semantic-release/git)

-   [github](https://github.com/semantic-release/github)

We have a few custom plugins that we use:

-   [defer-release](custom/semantic-release-defer-release.js)

-   [update-deps](custom/semantic-release-update-deps.js)

-   [apphub](custom/semantic-release-apphub.js)

# Usage

Create a workflow, or use an example from

[dhis2/workflows](https://github.com/dhis2/workflows) as a base.

To use in an existing workflow, add the action to a step after the build

process:

```

- uses: dhis2/action-semantic-release@master

  with:

      github-token: ${{ env.GH_TOKEN }}

```

It is possible to lock the action version by referencing a tag in the

`uses` statement, e.g.: `dhis2/[email protected]`.

We use `GH_TOKEN` and not `GITHUB_TOKEN` to distinguish between the user

who pushed (`GITHUB_TOKEN`) and the PAT of the account (`GH_TOKEN`) that

we want to trigger the release.

# Options

See the [`action.yml`](action.yml) file for an overview of the

configuration possibilities. In DHIS2 scenarios, the defaults should be

sane.

# Assets

Some assets are committed with the release commit:

-   `API.md` and `**/API.md`

-   `yarn.lock` and `**/yarn.lock`

-   `package.json` and `**/package.json`

-   `CHANGELOG.md`