antonyurchenko/git-release repository overview

⁠git-release

A GitHub Action for creating a GitHub Release with Assets and Changelog whenever a new Tag is pushed to the repository.

⁠Features

• Parse Tag to match Semantic Versioning
• Upload build artifacts (assets) to the release
• Add a changelog to the release
• Linux/Windows runners supported
• Filename pattern matching

⁠Manual

1. Add changes to CHANGELOG.md according to keepachangelog.com⁠. For example:

## [3.4.0] - 2020-07-10
### Added
- Glob pattern support
- Unit Tests
- Log version

### Fixed
- Exception on margins larger than context of changelog
- Nil pointer exception in 'release' package

### Changed
- Refactor JavaScript wrapper

## [3.3.0] - 2020-06-27
### Added
- Wrapper script: allow execution on Windows runners

### Changed
- Action execution through Git: from Docker to NodeJS

[3.4.0]: https://github.com/anton-yurchenko/git-release/compare/v3.3.0...v3.4.0
[3.3.0]: https://github.com/anton-yurchenko/git-release/releases/tag/v3.3.0

1. Tag a commit with Version (according to semver.org⁠).
2. Push and watch Git-Release publishing a Release on GitHub :wink:
   

⁠Configuration

1. Change the workflow to be triggered on Tag Push:
   • For example '*' or a more specific like 'v*':

on:
  push:
    tags:
    - 'v*'

1. Add Release step to your workflow:

    - name: Release
      uses: docker://antonyurchenko/git-release:latest
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        DRAFT_RELEASE: "false"
        PRE_RELEASE: "false"
        CHANGELOG_FILE: "CHANGELOG.md"
        ALLOW_EMPTY_CHANGELOG: "false"
        ALLOW_TAG_PREFIX: "true"
      with:
        args: |
            build/*-amd64.zip

    - name: Release
      uses: anton-yurchenko/git-release@master
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        DRAFT_RELEASE: "false"
        PRE_RELEASE: "false"
        CHANGELOG_FILE: "CHANGELOG.md"
        ALLOW_EMPTY_CHANGELOG: "false"
        ALLOW_TAG_PREFIX: "true"
      with:
        args: |
            build\\darwin-amd64.zip
            build\\linux-amd64.zip
            build\\windows-amd64.zip

:information_source: Configuration Examples⁠

⁠Remarks

• Git Tag should be identical to Changelog Version (without prefixes), for example tag v1.0.0 and changelog version 1.0.0.
• This action is automatically built at Docker Hub, and tagged with latest / v3 / v3.4 / v3.4.1. You may lock to a certain version instead of using latest.
  (Recommended to lock against a major version, for example v3)
• Instead of using a pre-built Docker image, you may execute the action through JavaScript wrapper by changing docker://antonyurchenko/git-release:latest to anton-yurchenko/git-release@master
• git-release operates assets with pattern matching, this means that it is unable to validate whether an asset exists or not.

⁠License

MIT⁠ © 2019-present Anton Yurchenko