Skip to content

Commit

Permalink
Update changelog for GH actions
Browse files Browse the repository at this point in the history
  • Loading branch information
Cadair committed Mar 1, 2023
1 parent 6cafcf6 commit 9136db4
Show file tree
Hide file tree
Showing 3 changed files with 128 additions and 95 deletions.
33 changes: 33 additions & 0 deletions .github/workflows/update-changelog.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# This workflow takes the GitHub release notes an updates the changelog on the
# main branch with the body of the release notes, thereby keeping a log in
# the git repo of the changes.

name: "Update Changelog"

on:
release:
types: [released]

jobs:
update:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v2
with:
ref: main

- name: Update Changelog
uses: stefanzweifel/changelog-updater-action@v1
with:
release-notes: ${{ github.event.release.body }}
latest-version: ${{ github.event.release.name }}
path-to-changelog: CHANGES.md

- name: Commit updated CHANGELOG
uses: stefanzweifel/git-auto-commit-action@v4
with:
branch: main
commit_message: Update CHANGELOG
file_pattern: CHANGES.md
95 changes: 95 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
# Sphinx_Changelog v1.2.0 (2022-08-31)

This release requires towncrier 22.8.0

* docs: Fix typo in level by @jmartens in https://github.com/OpenAstronomy/sphinx-changelog/pull/13
* Fix for removed `top_line` argument in towncrier renderer by @ConorMacBride in https://github.com/OpenAstronomy/sphinx-changelog/pull/14

## New Contributors
* @jmartens made their first contribution in https://github.com/OpenAstronomy/sphinx-changelog/pull/13
* @ConorMacBride made their first contribution in https://github.com/OpenAstronomy/sphinx-changelog/pull/14

**Full Changelog**: https://github.com/OpenAstronomy/sphinx-changelog/compare/v1.1.2...v1.2.0

# Sphinx_Changelog v1.1.2 (2021-08-19)

## Bug Fixes

- Explicitly specify encoding when writing changelog.
([\#11](https://github.com/OpenAstronomy/sphinx-changelog/pull/11))
- Fixed rendering to match towncrier, which means that top_line should
not be included in the template.
([\#12](https://github.com/OpenAstronomy/sphinx-changelog/pull/12))

# Sphinx_Changelog v1.1.1 (2021-05-14)

## Bug Fixes

- Re-implement the `:towncrier-skip-if-empty:` flag as it was dropped
in the upgrade to 21.3.
([\#10](https://github.com/OpenAstronomy/sphinx-changelog/pull/10))

# Sphinx_Changelog v1.1.0 (2021-05-11)

No significant changes.

# Sphinx_Changelog 1.1.0rc1 (2021-05-11)

## Features

- Update to support only the latest release of towncrier as there were
some substantial changes.
([\#9](https://github.com/OpenAstronomy/sphinx-changelog/pull/9))
- Added support for controlling the title underline used by towncrier
in the changelog directive.
([\#9](https://github.com/OpenAstronomy/sphinx-changelog/pull/9))

# Sphinx_Changelog v1.0.0 (2021-03-16)

No significant changes.

# Sphinx_Changelog v0.1rc5 (2021-03-03)

## Bug Fixes

- Do not raise exceptions inside the directive as this can cause the
sphinx parallel build to fail.
([\#8](https://github.com/OpenAstronomy/sphinx-changelog/pull/8))

# Sphinx_Changelog v0.1rc4 (2021-03-02)

## Features

- Add a flag to skip running towncrier if no fragment files are found.
([\#6](https://github.com/OpenAstronomy/sphinx-changelog/pull/6))

## Bug Fixes

- Fix resolving paths relative to the file containing the changelog
directive.
([\#6](https://github.com/OpenAstronomy/sphinx-changelog/pull/6))

# Sphinx_Changelog v0.1rc3 (2021-03-02)

## Bug Fixes

- Raise a more helpful error if no towncrier config can be found.
([\#5](https://github.com/OpenAstronomy/sphinx-changelog/pull/5))

# Sphinx_Changelog v0.1rc2 (2021-03-01)

## Features

- Implement options for changelog backend. Including the existing
changelog and towncrier are currently available.
([\#1](https://github.com/OpenAstronomy/sphinx-changelog/pull/1))

## Bug Fixes

- Fix use of template and update to parsing code from a newer
towncrier version
([\#3](https://github.com/OpenAstronomy/sphinx-changelog/pull/3))

# Sphinx_Changelog v0.1rc1 (2021-03-01)

Initial implementation copied from [sunpy](https://sunpy.org).
95 changes: 0 additions & 95 deletions CHANGELOG.rst

This file was deleted.

0 comments on commit 9136db4

Please sign in to comment.