Skip to content

Commit

Permalink
Automate release notes (CrayLabs#568)
Browse files Browse the repository at this point in the history
This PR adds a `release.yml` file to the root of the `.github` folder.
Within the file we configure the release notes generated through PR
tags. This PR also converts the changelog format from rst to md to match
release notes format.

[ reviewed by @AlyssaCote ]
[ committed by @amandarichardsonn ]
  • Loading branch information
amandarichardsonn authored Apr 30, 2024
1 parent 7db8490 commit 674b421
Show file tree
Hide file tree
Showing 6 changed files with 996 additions and 859 deletions.
56 changes: 56 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
#
# BSD 2-Clause License
#
# Copyright (c) 2021-2024, Hewlett Packard Enterprise
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#

changelog:
exclude:
labels:
- ignore-for-release
categories:
- title: Features
labels:
- 'type: feature'
exclude:
labels:
- non-user-facing
- title: Bug Fixes
labels:
- 'bug: critical'
- 'bug: major'
- 'bug: minor'
exclude:
labels:
- non-user-facing
- title: API Breaks
labels:
- 'API break'
exclude:
labels:
- non-user-facing
- title: Miscellaneous Improvements
labels:
- "*"
4 changes: 2 additions & 2 deletions .github/workflows/changelog.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,5 @@ jobs:
- name: Changelog Enforcer
uses: dangoslen/changelog-enforcer@v3.6.0
with:
changeLogPath: './doc/changelog.rst'
missingUpdateErrorMessage: 'changelog.rst has not been updated'
changeLogPath: './doc/changelog.md'
missingUpdateErrorMessage: 'changelog.md has not been updated'
Loading

0 comments on commit 674b421

Please sign in to comment.