Skip to content

Commit

Permalink
Merge pull request #90 from dhomeier/auto-release
Browse files Browse the repository at this point in the history
Setup automated changelog generation for release process
  • Loading branch information
astrofrog authored Oct 25, 2022
2 parents a891a4b + b22a009 commit 885c967
Show file tree
Hide file tree
Showing 8 changed files with 150 additions and 75 deletions.
21 changes: 21 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -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:
- "*"
14 changes: 4 additions & 10 deletions .github/workflows/ci_workflows.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: CI Workflows
name: CI Tests

on:
push:
Expand All @@ -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
Expand All @@ -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:
Expand Down
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 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
73 changes: 73 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -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
59 changes: 0 additions & 59 deletions CHANGES.rst

This file was deleted.

2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
include LICENSE
include README.rst
include CHANGES.rst
include CHANGES.md
12 changes: 7 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Glue WorldWide Telescope plugin (experimental)
==============================================

|Travis Status| |AppVeyor Status|
|Actions Status| |Coverage Status|

Requirements
------------
Expand Down Expand Up @@ -39,7 +39,9 @@ To run the tests, do::
at the root of the repository. This requires the
`pytest <http://pytest.org>`__ 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_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
:alt: Glue WWT's Coverage Status
11 changes: 11 additions & 0 deletions RELEASE.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
How to release a new version of Glue-WWT
========================================

#. Follow the instructions in the `Glue documentation
<http://docs.glueviz.org/en/stable/developer_guide/release.html>`_
to create a release using the `GitHub menu
<https://github.com/glue-viz/glue-wwt/releases/new>`_.

#. Have a beverage of your choosing while you can check the build progress
`here <https://github.com/glue-viz/glue-wwt/actions/>`_.
(The wheels may take a little while to build).

0 comments on commit 885c967

Please sign in to comment.