Skip to content

Commit

Permalink
Merge pull request #169 from ConorMacBride/fix-changelog-branch
Browse files Browse the repository at this point in the history
Rename default branch to `main`
  • Loading branch information
ConorMacBride committed Jun 16, 2022
2 parents 4d9951c + c050129 commit 48e652f
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 6 deletions.
7 changes: 3 additions & 4 deletions .github/workflows/update-changelog.yaml
@@ -1,11 +1,10 @@
# This workflow takes the GitHub release notes an updates the changelog on the
# master branch with the body of the release notes, thereby keeping a log in
# main branch with the body of the release notes, thereby keeping a log in
# the git repo of the changes.

name: "Update Changelog"

on:
workflow_dispatch:
release:
types: [released]

Expand All @@ -17,7 +16,7 @@ jobs:
- name: Checkout code
uses: actions/checkout@v2
with:
ref: master
ref: main

- name: Update Changelog
uses: stefanzweifel/changelog-updater-action@v1
Expand All @@ -29,6 +28,6 @@ jobs:
- name: Commit updated CHANGELOG
uses: stefanzweifel/git-auto-commit-action@v4
with:
branch: master
branch: main
commit_message: Update CHANGELOG
file_pattern: CHANGES.md
22 changes: 22 additions & 0 deletions CHANGES.md
@@ -1,3 +1,25 @@
## v0.16.0 - 2022-06-14

### Fixes

- Make summary log message about test results in general instead of failures by @neutrinoceros in https://github.com/matplotlib/pytest-mpl/pull/148
- Add support for classes with pytest 7 by @ConorMacBride in https://github.com/matplotlib/pytest-mpl/pull/164
Note that this change necessitated a minor breaking change for figure tests within classes only, and the following will need to be done:
- Hash library test names will need to be regenerated/updated to include the class name.
- If the undocumented `mpl-use-full-test-name` ini option is enabled, the the baseline images will need to be regenerated, or have their filename updated to include the class name.

### Other Changes

- Improve parametrized test names in HTML summaries by @ConorMacBride in https://github.com/matplotlib/pytest-mpl/pull/165

### Infrastructure Changes

- Pin tox environment `mpl35` to matplotlib 3.5.1 by @ConorMacBride in https://github.com/matplotlib/pytest-mpl/pull/162
- [pre-commit.ci] pre-commit autoupdate by @pre-commit-ci in https://github.com/matplotlib/pytest-mpl/pull/167
- Improve `tests/subtests` by @ConorMacBride in https://github.com/matplotlib/pytest-mpl/pull/163

**Full Changelog**: https://github.com/matplotlib/pytest-mpl/compare/v0.15.1...v0.16.0

## v0.15.1 - 2022-04-22

### Fixes
Expand Down
4 changes: 2 additions & 2 deletions RELEASING.md
Expand Up @@ -2,10 +2,10 @@

To make a new release of pytest-mpl follow the following steps:

* Ensure the sdist and wheel GitHub Actions jobs succeeded on master after the last merge.
* Ensure the sdist and wheel GitHub Actions jobs succeeded on main after the last merge.
* Also ensure that the tarball built has an autogenerated version number from setuptools_scm.
* Write the release notes in the GitHub releases UI, use the autogenerated
notes and tidy up a little.
* Publish the new release, using the format `vX.Y.X`.
* Watch as GitHub actions builds the sdist and universal wheel and pushes them to PyPI for you, and updates CHANGES.md on the master branch.
* Watch as GitHub actions builds the sdist and universal wheel and pushes them to PyPI for you, and updates CHANGES.md on the main branch.
* Enjoy the beverage of your choosing 🍻.

0 comments on commit 48e652f

Please sign in to comment.