Skip to content

Commit

Permalink
Changed how CHANGELOG.md is generated. [#291]
Browse files Browse the repository at this point in the history
Switched over to using charmixer/auto-changelog-action
  • Loading branch information
mcpierce committed Jun 21, 2020
1 parent b063e00 commit 9372a8b
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 5 deletions.
17 changes: 12 additions & 5 deletions .github/workflows/create-release.yml
Expand Up @@ -16,13 +16,20 @@ jobs:
java-version: 1.8
- name: Checkout code
uses: actions/checkout@master
- name: Generate CHANGELOG.md
uses: charmixer/auto-changelog-action@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
release_branch: ${{ github.ref }}
since_tag: v0.5.2-2
- name: Build project
run: mvn package -Pci -DskipTests -Dassembly-name=RELEASE
- name: Generate release
uses: "marvinpinto/action-automatic-releases@latest"
- name: Upload release artifact
uses: softprops/action-gh-release@v1
if: startsWith(github.ref, 'refs/tags/')
with:
repo_token: "${{ secrets.GITHUB_TOKEN }}"
prerelease: false
body_path: CHANGELOG.md
files: |
changelog
comixed-app/target/artifacts/comixed-app-0.6.0-0.rc1-RELEASE.zip
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
7 changes: 7 additions & 0 deletions CHANGELOG.md
@@ -0,0 +1,7 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Expand Up @@ -18,6 +18,18 @@ where **xxx** is the issue being addressed.
Using this template, your changes are then visible on the ticket's page. This lets everybody know
what changes were made for any issue.

### How To Describe The Change

See [Keep A Changelog](https://keepachangelog.com/en/1.0.0/) for a description for how to make a good changelog entry.
Each commit's summary should start with one of the following verbs:

* **Added** for a new feature,
* **Changed** for changes to existing functionality,
* **Deprecated** for soon-to-be removed features,
* **Removed** for now removed features,
* **Fixed** for any bug fixes, or
* **Security** in cases of vulnerabilities.

## Coding Conventions And Formatting

### Java
Expand Down

0 comments on commit 9372a8b

Please sign in to comment.