From 6248bbb7c6081a5cb45be0e8ee32eb27dcf43594 Mon Sep 17 00:00:00 2001 From: Derek Homeier Date: Tue, 25 Oct 2022 15:52:32 +0200 Subject: [PATCH 1/5] Add Yaml configs for release and autochangelog generator --- .github/release.yml | 21 ++++++++++++++++ .github/workflows/update-changelog.yaml | 33 +++++++++++++++++++++++++ 2 files changed, 54 insertions(+) create mode 100644 .github/release.yml create mode 100644 .github/workflows/update-changelog.yaml diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 00000000..3fadb190 --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,21 @@ +changelog: + exclude: + authors: + - pre-commit-ci + labels: + - no-changelog-entry-needed + - skip-changelog + + categories: + - title: New Features + labels: + - enhancement + - title: Bug Fixes + labels: + - bug + - title: Documentation + labels: + - documentation + - title: Other Changes + labels: + - "*" diff --git a/.github/workflows/update-changelog.yaml b/.github/workflows/update-changelog.yaml new file mode 100644 index 00000000..5e4e1c47 --- /dev/null +++ b/.github/workflows/update-changelog.yaml @@ -0,0 +1,33 @@ +# This workflow takes the GitHub release notes and 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 From ef1443d288cac756f6a23ab81cc6a00a1333a6b5 Mon Sep 17 00:00:00 2001 From: Derek Homeier Date: Tue, 25 Oct 2022 15:57:19 +0200 Subject: [PATCH 2/5] DOC: new release process instructions and CI badges [ci skip] --- .github/workflows/ci_workflows.yml | 2 +- README.rst | 11 ++++++----- RELEASE.rst | 11 +++++++++++ 3 files changed, 18 insertions(+), 6 deletions(-) create mode 100644 RELEASE.rst diff --git a/.github/workflows/ci_workflows.yml b/.github/workflows/ci_workflows.yml index a13e1a1e..122796ea 100644 --- a/.github/workflows/ci_workflows.yml +++ b/.github/workflows/ci_workflows.yml @@ -1,4 +1,4 @@ -name: CI Workflows +name: CI Tests on: push: diff --git a/README.rst b/README.rst index 90808b05..42dbf121 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ Glue WorldWide Telescope plugin (experimental) ============================================== -|Travis Status| |AppVeyor Status| +|Actions Status| |Coverage Status| Requirements ------------ @@ -39,7 +39,8 @@ To run the tests, do:: at the root of the repository. This requires the `pytest `__ module to be installed. -.. |Travis Status| image:: https://travis-ci.org/glue-viz/glue-wwt.svg - :target: https://travis-ci.org/glue-viz/glue-wwt?branch=master -.. |AppVeyor Status| image:: https://ci.appveyor.com/api/projects/status/8cxo7uvxd8avuj7p/branch/master?svg=true - :target: https://ci.appveyor.com/project/glue-viz/glue-wwt/branch/master +.. |Actions Status| image:: https://github.com/glue-viz/glue-wwt/workflows/CI%20Tests/badge.svg + :target: https://github.com/glue-viz/glue-wwt/actions + :alt: Glue WWT's GitHub Actions CI Status +.. |Coverage Status| image:: https://codecov.io/gh/glue-viz/glue-wwt/branch/master/graph/badge.svg + :target: https://codecov.io/gh/glue-viz/glue-wwt diff --git a/RELEASE.rst b/RELEASE.rst new file mode 100644 index 00000000..d83e524e --- /dev/null +++ b/RELEASE.rst @@ -0,0 +1,11 @@ +How to release a new version of Glue-WWT +======================================== + +#. Follow the instructions in the `Glue documentation + `_ + to create a release using the `GitHub menu + `_. + +#. Have a beverage of your choosing while you can check the build progress + `here `_. + (The wheels may take a little while to build). From f98ed7a59986c5fd6bc2575f201d8717ed4cebe6 Mon Sep 17 00:00:00 2001 From: Derek Homeier Date: Tue, 25 Oct 2022 16:15:18 +0200 Subject: [PATCH 3/5] DOC: reformat Changelog --- CHANGES.md | 73 +++++++++++++++++++++++++++++++++++++++++++++++++++++ CHANGES.rst | 59 ------------------------------------------- 2 files changed, 73 insertions(+), 59 deletions(-) create mode 100644 CHANGES.md delete mode 100644 CHANGES.rst diff --git a/CHANGES.md b/CHANGES.md new file mode 100644 index 00000000..9ff2dbd8 --- /dev/null +++ b/CHANGES.md @@ -0,0 +1,73 @@ +# Full changelog + +## [0.5](https://github.com/glue-viz/glue-wwt/compare/v0.4...v0.5) - 2020-11-30 + +### What's Changed + +#### New Features + +- Included a save button to save the current view to the first slide of a tour. [https://github.com/glue-viz/glue-wwt/pull/70, https://github.com/glue-viz/glue-wwt/pull/72, https://github.com/glue-viz/glue-wwt/pull/73] + +- Added initial support for using glue-wwt in Jupyter. [https://github.com/glue-viz/glue-wwt/pull/64] + +#### Bug Fixes + +- Fixed compatibility with glue-core 1.0. [https://github.com/glue-viz/glue-wwt/pull/77] + +- Fixed a bug that caused altitude unit to not work correctly on Windows. [https://github.com/glue-viz/glue-wwt/pull/74] + +- Fixed a bug related to reloading sessions with WWT viewers. [https://github.com/glue-viz/glue-wwt/pull/76] + +## [0.4](https://github.com/glue-viz/glue-wwt/compare/v0.3...v0.4) - 2019-06-23 + +### What's Changed + +#### Bug Fixes + +- Fixed bug with layer centering when NaN values are present. [https://github.com/glue-viz/glue-wwt/pull/55] + +- Fixed issues with layer visibility. [https://github.com/glue-viz/glue-wwt/pull/52] + +- Fixed bug that caused remonving layers to not work. [https://github.com/glue-viz/glue-wwt/pull/56] + +- Fixed issue with viewer options not being set correctly when loading from a session. [https://github.com/glue-viz/glue-wwt/pull/52] + +- Fixed compatibility with the latest developer version of glue. [https://github.com/glue-viz/glue-wwt/pull/52] + +- Fixed issue with automatic installation of dependencies. [https://github.com/glue-viz/glue-wwt/pull/52] + +## [0.3](https://github.com/glue-viz/glue-wwt/compare/v0.2...v0.3) - 2019-02-27 + +### What's Changed + +#### New Features + +- Added support for showing data on the surface of celestial bodies as well as + in the 3D Solar System/Milky Way/Universe view. [https://github.com/glue-viz/glue-wwt/pull/40, https://github.com/glue-viz/glue-wwt/pull/42] + +- Added support for color-coding and changing point size based on attributes + (requires PyWWT 0.6 or later). [https://github.com/glue-viz/glue-wwt/pull/44] + +## [0.2](https://github.com/glue-viz/glue-wwt/compare/v0.1...v0.2) - 2018-12-29 + +### What's Changed + +#### New Features + +- Add a Save button to save the current view to a file. [https://github.com/glue-viz/glue-wwt/pull/38] + +#### Bug Fixes + +- Fix compatibility with latest version of glue. [https://github.com/glue-viz/glue-wwt/pull/25] + +- Allow world coordinates to be used for the RA/Dec. [https://github.com/glue-viz/glue-wwt/pull/21] + +#### Other Changes + +- Make use of PyWWT. [https://github.com/glue-viz/glue-wwt/pull/32, https://github.com/glue-viz/glue-wwt/pull/35] + +- Change default foreground and background imagery. [https://github.com/glue-viz/glue-wwt/pull/29] + +## [0.1](https://github.com/glue-viz/glue-wwt/releases/tag/v0.1) - 2017-08-23 + +- Initial release diff --git a/CHANGES.rst b/CHANGES.rst deleted file mode 100644 index ffe97f09..00000000 --- a/CHANGES.rst +++ /dev/null @@ -1,59 +0,0 @@ -0.6 (unreleased) ----------------- - -- Added setting controls for image layers. [#88] - -0.5 (2020-11-30) ----------------- - -- Fixed compatibility with glue-core 1.0. [#77] - -- Fixed a bug that caused altitude unit to not work correctly on Windows. [#74] - -- Fixed a bug related to reloading sessions with WWT viewers. [#76] - -- Included a save button to save the current view to the first slide of a tour. [#70, #72, #73] - -- Added initial support for using glue-wwt in Jupyter. [#64] - -0.4 (2019-06-23) ----------------- - -- Fixed bug with layer centering when NaN values are present. [#55] - -- Fixed issues with layer visibility. [#52] - -- Fixed bug that caused remonving layers to not work. [#56] - -- Fixed issue with viewer options not being set correctly when loading from a session. [#52] - -- Fixed compatibility with the latest developer version of glue. [#52] - -- Fixed issue with automatic installation of dependencies. [#52] - -0.3 (2019-02-27) ----------------- - -- Added support for showing data on the surface of celestial bodies as well as - in the 3D Solar System/Milky Way/Universe view. [#40, #42] - -- Added support for color-coding and changing point size based on attributes - (requires PyWWT 0.6 or later). [#44] - -0.2 (2018-12-29) ----------------- - -- Add a Save button to save the current view to a file. [#38] - -- Make use of PyWWT. [#32, #35] - -- Change default foreground and background imagery. [#29] - -- Fix compatibility with latest version of glue. [#25] - -- Allow world coordinates to be used for the RA/Dec. [#21] - -0.1 (2017-08-23) ----------------- - -- Initial release From 5c40465d9e4bde0bba0885e3ffebad9a6544071f Mon Sep 17 00:00:00 2001 From: Derek Homeier Date: Tue, 25 Oct 2022 16:29:28 +0200 Subject: [PATCH 4/5] TST: missing xcb libs --- .github/workflows/ci_workflows.yml | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/.github/workflows/ci_workflows.yml b/.github/workflows/ci_workflows.yml index 122796ea..598b168f 100644 --- a/.github/workflows/ci_workflows.yml +++ b/.github/workflows/ci_workflows.yml @@ -12,14 +12,8 @@ jobs: coverage: codecov libraries: | apt: - - libxkbcommon-x11-0 - - libxcb-icccm4 - - libxcb-image0 - - libxcb-keysyms1 - - libxcb-randr0 - - libxcb-render-util0 - - libxcb-xfixes0 - - libxcb-xinerama0 + - '^libxcb.*-dev' + - libxkbcommon-x11-dev envs: | # Code style @@ -45,7 +39,7 @@ jobs: uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@v1 with: # setup headless X server as per pyvista/setup-headless-display-action@v1 - libraries: 'libxkbcommon-x11-dev libxcb-icccm4-dev libxcb-image0-dev libxcb-keysyms1-dev libxcb-randr0-dev libxcb-render-util0-dev libxcb-xfixes0 libxcb-xinerama0-dev libgl1-mesa-glx xvfb' + libraries: '^libxcb.*-dev libxkbcommon-x11-dev xvfb' test_extras: 'test,qt' test_command: Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 & sleep 3; DISPLAY=:99.0 pytest --pyargs glue_wwt secrets: From b22a0092ca69e463a4dd80892ac2eae22eb71cfe Mon Sep 17 00:00:00 2001 From: Derek Homeier Date: Tue, 25 Oct 2022 19:42:18 +0200 Subject: [PATCH 5/5] DOC: fix README badges, MANIFEST --- MANIFEST.in | 2 +- README.rst | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/MANIFEST.in b/MANIFEST.in index a3db2a9c..c56cb1b8 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,3 +1,3 @@ include LICENSE include README.rst -include CHANGES.rst +include CHANGES.md diff --git a/README.rst b/README.rst index 42dbf121..567f74c7 100644 --- a/README.rst +++ b/README.rst @@ -39,8 +39,9 @@ To run the tests, do:: at the root of the repository. This requires the `pytest `__ module to be installed. -.. |Actions Status| image:: https://github.com/glue-viz/glue-wwt/workflows/CI%20Tests/badge.svg +.. |Actions Status| image:: https://github.com/glue-viz/glue-wwt/workflows/ci_workflows/badge.svg :target: https://github.com/glue-viz/glue-wwt/actions :alt: Glue WWT's GitHub Actions CI Status .. |Coverage Status| image:: https://codecov.io/gh/glue-viz/glue-wwt/branch/master/graph/badge.svg - :target: https://codecov.io/gh/glue-viz/glue-wwt + :target: https://codecov.io/gh/glue-viz/glue-wwt + :alt: Glue WWT's Coverage Status