From c495f7ecbd75facaeb186bb62d0fcb32d378c08f Mon Sep 17 00:00:00 2001 From: Stuart Mumford Date: Mon, 9 Dec 2024 13:39:34 +0000 Subject: [PATCH 1/4] Update cruft with batchpr --- .cruft.json | 12 ++++++------ pyproject.toml | 18 ++++++++++++++++++ 2 files changed, 24 insertions(+), 6 deletions(-) diff --git a/.cruft.json b/.cruft.json index d0093aa..41c2471 100644 --- a/.cruft.json +++ b/.cruft.json @@ -1,6 +1,6 @@ { "template": "https://github.com/sunpy/package-template", - "commit": "3737aa309d2a695ada046c7868c5683213003f3d", + "commit": "5446d70263fff597b33ca7b0833aaeb5f3c3ac59", "checkout": null, "context": { "cookiecutter": { @@ -10,12 +10,12 @@ "author_name": "The SunPy Developers", "author_email": "sunpy@googlegroups.com", "project_url": "https://docs.sunpy.org/projects/mpl-animators", - "github_repo": "", - "sourcecode_url": "", + "github_repo": "sunpy/mpl-animators", + "sourcecode_url": "https://github.com/sunpy/mpl-animators", "download_url": "https://pypi.org/project/mpl_animators", - "documentation_url": "", - "changelog_url": "", - "issue_tracker_url": "", + "documentation_url": "https://docs.sunpy.org/projects/mpl-animators", + "changelog_url": "https://docs.sunpy.org/projects/mpl-animators/en/stable/whatsnew/changelog.html", + "issue_tracker_url": "https://github.com/sunpy/mpl-animators/issues", "license": "BSD 3-Clause", "minimum_python_version": "3.10", "use_compiled_extensions": "n", diff --git a/pyproject.toml b/pyproject.toml index 846f8c9..7f753e2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -43,10 +43,16 @@ docs = [ [project.urls] Homepage = "https://docs.sunpy.org/projects/mpl-animators" +"Source Code" = "https://github.com/sunpy/mpl-animators" Download = "https://pypi.org/project/mpl_animators" +<<<<<<< "Source Code" = "https://github.com/sunpy/mpl-animators/" Documentation = "https://docs.sunpy.org/projects/mpl-animators" Changelog = "https://github.com/sunpy/mpl-animators/releases" +======= +Documentation = "https://docs.sunpy.org/projects/mpl-animators" +Changelog = "https://docs.sunpy.org/projects/mpl-animators/en/stable/whatsnew/changelog.html" +>>>>>>> "Issue Tracker" = "https://github.com/sunpy/mpl-animators/issues" [tool.setuptools] @@ -87,8 +93,16 @@ write_to = "mpl_animators/_version.py" verify_pr_number = true changelog_skip_label = "No Changelog Entry Needed" help_url = "https://github.com/sunpy/mpl-animators/blob/main/changelog/README.rst" +<<<<<<< changelog_missing_long = "There isn't a changelog file in this pull request. Please add a changelog file to the `changelog/` directory following the instructions in the changelog [README](https://github.com//blob/main/changelog/README.rst)." type_incorrect_long = "The changelog file you added is not one of the allowed types. Please use one of the types described in the changelog [README](https://github.com//blob/main/changelog/README.rst)" +======= + + changelog_missing_long = "There isn't a changelog file in this pull request. Please add a changelog file to the `changelog/` directory following the instructions in the changelog [README](https://github.com/sunpy/mpl-animators/blob/main/changelog/README.rst)." + + type_incorrect_long = "The changelog file you added is not one of the allowed types. Please use one of the types described in the changelog [README](https://github.com/sunpy/mpl-animators/blob/main/changelog/README.rst)" + +>>>>>>> number_incorrect_long = "The number in the changelog file you added does not match the number of this pull request. Please rename the file." # TODO: This should be in towncrier.toml but Giles currently only works looks in @@ -97,7 +111,11 @@ write_to = "mpl_animators/_version.py" package = "mpl_animators" filename = "CHANGELOG.rst" directory = "changelog/" +<<<<<<< issue_format = "`#{issue} https:github.com/mpl-animators/pull/{issue}>`__" +======= + issue_format = "`#{issue} `__" +>>>>>>> title_format = "{version} ({project_date})" [[tool.towncrier.type]] From d0b99e65358d25df5428372ed3ffa27d311d2c0c Mon Sep 17 00:00:00 2001 From: Stuart Mumford Date: Mon, 9 Dec 2024 13:41:58 +0000 Subject: [PATCH 2/4] stuff --- pyproject.toml | 16 ---------------- 1 file changed, 16 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 7f753e2..1dcf845 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -43,16 +43,9 @@ docs = [ [project.urls] Homepage = "https://docs.sunpy.org/projects/mpl-animators" -"Source Code" = "https://github.com/sunpy/mpl-animators" -Download = "https://pypi.org/project/mpl_animators" -<<<<<<< "Source Code" = "https://github.com/sunpy/mpl-animators/" Documentation = "https://docs.sunpy.org/projects/mpl-animators" Changelog = "https://github.com/sunpy/mpl-animators/releases" -======= -Documentation = "https://docs.sunpy.org/projects/mpl-animators" -Changelog = "https://docs.sunpy.org/projects/mpl-animators/en/stable/whatsnew/changelog.html" ->>>>>>> "Issue Tracker" = "https://github.com/sunpy/mpl-animators/issues" [tool.setuptools] @@ -93,16 +86,11 @@ write_to = "mpl_animators/_version.py" verify_pr_number = true changelog_skip_label = "No Changelog Entry Needed" help_url = "https://github.com/sunpy/mpl-animators/blob/main/changelog/README.rst" -<<<<<<< - changelog_missing_long = "There isn't a changelog file in this pull request. Please add a changelog file to the `changelog/` directory following the instructions in the changelog [README](https://github.com//blob/main/changelog/README.rst)." - type_incorrect_long = "The changelog file you added is not one of the allowed types. Please use one of the types described in the changelog [README](https://github.com//blob/main/changelog/README.rst)" -======= changelog_missing_long = "There isn't a changelog file in this pull request. Please add a changelog file to the `changelog/` directory following the instructions in the changelog [README](https://github.com/sunpy/mpl-animators/blob/main/changelog/README.rst)." type_incorrect_long = "The changelog file you added is not one of the allowed types. Please use one of the types described in the changelog [README](https://github.com/sunpy/mpl-animators/blob/main/changelog/README.rst)" ->>>>>>> number_incorrect_long = "The number in the changelog file you added does not match the number of this pull request. Please rename the file." # TODO: This should be in towncrier.toml but Giles currently only works looks in @@ -111,11 +99,7 @@ write_to = "mpl_animators/_version.py" package = "mpl_animators" filename = "CHANGELOG.rst" directory = "changelog/" -<<<<<<< - issue_format = "`#{issue} https:github.com/mpl-animators/pull/{issue}>`__" -======= issue_format = "`#{issue} `__" ->>>>>>> title_format = "{version} ({project_date})" [[tool.towncrier.type]] From e75d760b07d218e3939fd054b507c49fa9125ec1 Mon Sep 17 00:00:00 2001 From: Stuart Mumford Date: Mon, 9 Dec 2024 13:42:36 +0000 Subject: [PATCH 3/4] more --- .cruft.json | 4 ++-- pyproject.toml | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.cruft.json b/.cruft.json index 41c2471..8b7ef42 100644 --- a/.cruft.json +++ b/.cruft.json @@ -9,12 +9,12 @@ "short_description": "An interactive animation framework for matplotlib.", "author_name": "The SunPy Developers", "author_email": "sunpy@googlegroups.com", - "project_url": "https://docs.sunpy.org/projects/mpl-animators", + "project_url": "https://sunpy.org", "github_repo": "sunpy/mpl-animators", "sourcecode_url": "https://github.com/sunpy/mpl-animators", "download_url": "https://pypi.org/project/mpl_animators", "documentation_url": "https://docs.sunpy.org/projects/mpl-animators", - "changelog_url": "https://docs.sunpy.org/projects/mpl-animators/en/stable/whatsnew/changelog.html", + "changelog_url": "https://github.com/sunpy/mpl-animators/releases", "issue_tracker_url": "https://github.com/sunpy/mpl-animators/issues", "license": "BSD 3-Clause", "minimum_python_version": "3.10", diff --git a/pyproject.toml b/pyproject.toml index 1dcf845..509ea40 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -42,8 +42,9 @@ docs = [ ] [project.urls] -Homepage = "https://docs.sunpy.org/projects/mpl-animators" -"Source Code" = "https://github.com/sunpy/mpl-animators/" +Homepage = "https://sunpy.org" +"Source Code" = "https://github.com/sunpy/mpl-animators" +Download = "https://pypi.org/project/mpl_animators" Documentation = "https://docs.sunpy.org/projects/mpl-animators" Changelog = "https://github.com/sunpy/mpl-animators/releases" "Issue Tracker" = "https://github.com/sunpy/mpl-animators/issues" From 6d0ef1aa45623a0a2aa0b8e7900421219b6c5752 Mon Sep 17 00:00:00 2001 From: Stuart Mumford Date: Mon, 9 Dec 2024 14:00:53 +0000 Subject: [PATCH 4/4] Migrate changelog to towncrier --- .github/workflows/update-changelog.yaml | 33 -------------- .gitignore | 1 + CHANGELOG.rst | 59 +++++++++++++++++++++++++ CHANGES.md | 56 ----------------------- 4 files changed, 60 insertions(+), 89 deletions(-) delete mode 100644 .github/workflows/update-changelog.yaml delete mode 100644 CHANGES.md diff --git a/.github/workflows/update-changelog.yaml b/.github/workflows/update-changelog.yaml deleted file mode 100644 index 10651e0..0000000 --- a/.github/workflows/update-changelog.yaml +++ /dev/null @@ -1,33 +0,0 @@ -# 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@v4 - 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@v5 - with: - branch: main - commit_message: Update CHANGELOG - file_pattern: CHANGES.md diff --git a/.gitignore b/.gitignore index f737200..72e1651 100644 --- a/.gitignore +++ b/.gitignore @@ -75,6 +75,7 @@ instance/ # Sphinx documentation docs/_build/ +docs/generated/ # automodapi docs/api docs/sg_execution_times.rst diff --git a/CHANGELOG.rst b/CHANGELOG.rst index e69de29..5ee0438 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -0,0 +1,59 @@ +v1.1.2 - 2024-02-07 +=================== + +What’s Changed +-------------- + +Other Changes +~~~~~~~~~~~~~ + +- remove old circleci webhook config by @Cadair in https://github.com/sunpy/mpl-animators/pull/36 +- Added Gallery + Update Package template by @nabobalis in https://github.com/sunpy/mpl-animators/pull/37 + +v1.1.1 - 2023-11-17 +=================== + +What’s Changed +-------------- + +Other Changes +~~~~~~~~~~~~~ + +- Update for tox4 by @ConorMacBride in https://github.com/sunpy/mpl-animators/pull/20 +- Minor tweaks to CI - No actions by @nabobalis in https://github.com/sunpy/mpl-animators/pull/28 +- Move to actions by @nabobalis in https://github.com/sunpy/mpl-animators/pull/29 +- Bump stefanzweifel/git-auto-commit-action from 4 to 5 by @dependabot in https://github.com/sunpy/mpl-animators/pull/30 +- Bump actions/checkout from 2 to 4 by @dependabot in https://github.com/sunpy/mpl-animators/pull/31 + +New Contributors +---------------- + +- @ConorMacBride made their first contribution in https://github.com/sunpy/mpl-animators/pull/20 +- @nabobalis made their first contribution in https://github.com/sunpy/mpl-animators/pull/28 +- @dependabot made their first contribution in https://github.com/sunpy/mpl-animators/pull/30 + +v1.1.0 - 2022-08-10 +=================== + +What’s Changed +-------------- + +Bug Fixes +~~~~~~~~~ + +- Fix setting y limits when data is a dask array by SolarDrew in https://github.com/sunpy/mpl-animators/pull/11 + +Other Changes +~~~~~~~~~~~~~ + +- Add changelog config and bump minimum Python version to 3.8 by Cadair in https://github.com/sunpy/mpl-animators/pull/12 + +New Contributors +~~~~~~~~~~~~~~~~ + +- @SolarDrew made their first contribution in https://github.com/sunpy/mpl-animators/pull/11 + +v1.0.0 +====== + +Initial release with code copied from ``sunpy.visualisation.animators``. diff --git a/CHANGES.md b/CHANGES.md deleted file mode 100644 index 6fe08ec..0000000 --- a/CHANGES.md +++ /dev/null @@ -1,56 +0,0 @@ -# Changelog - -## v1.1.2 - 2024-02-07 - - -### What's Changed - -#### Other Changes - -* remove old circleci webhook config by @Cadair in https://github.com/sunpy/mpl-animators/pull/36 -* Added Gallery + Update Package template by @nabobalis in https://github.com/sunpy/mpl-animators/pull/37 - -**Full Changelog**: https://github.com/sunpy/mpl-animators/compare/v1.1.1...v1.1.2 - -## v1.1.1 - 2023-11-17 - - -### What's Changed - -#### Other Changes - -- Update for tox4 by @ConorMacBride in https://github.com/sunpy/mpl-animators/pull/20 -- Minor tweaks to CI - No actions by @nabobalis in https://github.com/sunpy/mpl-animators/pull/28 -- Move to actions by @nabobalis in https://github.com/sunpy/mpl-animators/pull/29 -- Bump stefanzweifel/git-auto-commit-action from 4 to 5 by @dependabot in https://github.com/sunpy/mpl-animators/pull/30 -- Bump actions/checkout from 2 to 4 by @dependabot in https://github.com/sunpy/mpl-animators/pull/31 - -### New Contributors - -- @ConorMacBride made their first contribution in https://github.com/sunpy/mpl-animators/pull/20 -- @nabobalis made their first contribution in https://github.com/sunpy/mpl-animators/pull/28 -- @dependabot made their first contribution in https://github.com/sunpy/mpl-animators/pull/30 - -**Full Changelog**: https://github.com/sunpy/mpl-animators/compare/v1.1.0...v1.1.1 - -## v1.1.0 - 2022-08-10 - -### What's Changed - -#### Bug Fixes - -- Fix setting y limits when data is a dask array by SolarDrew in [https://github.com/sunpy/mpl-animators/pull/11](https://github.com/sunpy/mpl-animators/pull/11) - -#### Other Changes - -- Add changelog config and bump minimum Python version to 3.8 by Cadair in [https://github.com/sunpy/mpl-animators/pull/12](https://github.com/sunpy/mpl-animators/pull/12) - -#### New Contributors - -- @SolarDrew made their first contribution in [https://github.com/sunpy/mpl-animators/pull/11](https://github.com/sunpy/mpl-animators/pull/11) - -**Full Changelog**: [https://github.com/sunpy/mpl-animators/compare/v1.0.1...v1.1.0](https://github.com/sunpy/mpl-animators/compare/v1.0.1...v1.1.0) - -## v1.0.0 - -Initial release with code copied from `sunpy.visualisation.animators`.