Merge pull request #499 from askap-vast/release-v3.0.1

Release v3.0.1
askap-vast · Sep 24, 2023 · 8201041 · 8201041
2 parents 02bdd06 + b878c7a
commit 8201041
Show file tree

Hide file tree

Showing 11 changed files with 167 additions and 107 deletions.
diff --git a/.github/workflows/ci-docs.yml b/.github/workflows/ci-docs.yml
@@ -1,23 +1,25 @@
 name: ci docs
+
 on:
-  push:
-    branches:
-      - master
-      - main
+ push:
+   branches:
+     - master
+     - main
+
 jobs:
   deploy:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     if: ${{ github.repository_owner == 'askap-vast' }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v4
         with:
-          python-version: 3.x
-      - uses: Gr1N/setup-poetry@v7
+          python-version: 3.9
+      - uses: Gr1N/setup-poetry@v8
       - name: Cache Python dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: ~/.cache/pypoetry/virtualenvs
           key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -7,22 +7,22 @@ jobs:
     runs-on: ubuntu-20.04
 
     steps:
-    - uses: actions/checkout@v2
-    - uses: ricardochaves/[email protected]
-      with:
-        use-pylint: false
-        use-pycodestyle: false
-        use-flake8: true
-        use-black: false
-        use-mypy: false
-        use-isort: false
-        extra-pylint-options: ""
-        extra-pycodestyle-options: ""
-        extra-flake8-options: "--select=W291,W292,F401"
-        # flake8 options being used:
-        #   - W291 trailing whitespace
-        #   - W292 no newline at end of file
-        #   - F401 module imported but unused
-        extra-black-options: ""
-        extra-mypy-options: ""
-        extra-isort-options: ""
+        - uses: actions/checkout@v4
+        - uses: ricardochaves/[email protected]
+          with:
+            use-pylint: false
+            use-pycodestyle: false
+            use-flake8: true
+            use-black: false
+            use-mypy: false
+            use-isort: false
+            extra-pylint-options: ""
+            extra-pycodestyle-options: ""
+            extra-flake8-options: "--select=W291,W292,F401"
+            # flake8 options being used:
+            #   - W291 trailing whitespace
+            #   - W292 no newline at end of file
+            #   - F401 module imported but unused
+            extra-black-options: ""
+            extra-mypy-options: ""
+            extra-isort-options: ""
diff --git a/.github/workflows/pytest.yml b/.github/workflows/pytest.yml
@@ -11,20 +11,20 @@ jobs:
         python_version: ['3.8', '3.9']
 
     steps:
-    - uses: actions/checkout@v2
+        - uses: actions/checkout@v4
 
-    - uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python_version }}
-    - uses: Gr1N/setup-poetry@v8
-    - name: Cache Python dependencies
-      uses: actions/cache@v2
-      with:
-        path: ~/.cache/pypoetry/virtualenvs
-        key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
+        - uses: actions/setup-python@v4
+          with:
+            python-version: ${{ matrix.python_version }}
+        - uses: Gr1N/setup-poetry@v8
+        - name: Cache Python dependencies
+          uses: actions/cache@v3
+          with:
+            path: ~/.cache/pypoetry/virtualenvs
+            key: ${{ runner.os }}-poetry-${{ hashFiles('poetry.lock') }}
 
-    - name: Install python dependencies
-      run: poetry install
-    - name: Run pytests
-      run: |
-        poetry run pytest --cov=vasttools -vv
+        - name: Install python dependencies
+          run: poetry install
+        - name: Run pytests
+          run: |
+            poetry run pytest --cov=vasttools -vv
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), with an added `List of PRs` section and links to the relevant PRs on the individal updates. This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased](https://github.com/askap-vast/vast-tools/compare/v3.0.0...HEAD)
+## [Unreleased](https://github.com/askap-vast/vast-tools/compare/v3.0.1...HEAD)
 
 #### Added
 
@@ -16,6 +16,23 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 #### List of PRs
 
+## [3.0.1](https://github.com/askap-vast/vast-tools/releases/v3.0.1) (2023-09-24)
+
+#### Changed
+
+- Bumped `mkdocstrings` to version `0.17.0` to avoid `mkdocstrings` error [#496](https://github.com/askap-vast/vast-tools/pull/496).
+- Pinned `jinja2` to version `3.0.3` to avoid `mkdocs_autoref` error [#496](https://github.com/askap-vast/vast-tools/pull/496).
+- Update github workflows to latest versions [#496](https://github.com/askap-vast/vast-tools/pull/496)
+- Exit nicely when invalid survey is requested for SkyView contour plot [#497](https://github.com/askap-vast/vast-tools/pull/497)
+
+#### Fixed
+
+- Fixed docs build process [#496](https://github.com/askap-vast/vast-tools/pull/496).
+
+#### List of PRs
+
+- [#496](https://github.com/askap-vast/vast-tools/pull/496): fix: Update github workflows to latest versions
+- [#497](https://github.com/askap-vast/vast-tools/pull/497): feat: Exit nicely when invalid survey is requested for SkyView contour plot
 
 ## [3.0.0](https://github.com/askap-vast/vast-tools/releases/v3.0.0) (2023-09-02)
 
@@ -123,14 +140,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 #### List of PRs
 
 - [#490](https://github.com/askap-vast/vast-tools/pull/490): feat: Raise exception when simbad name query returns more names than there are objects queried
-- [#478](https://github.com/askap-vast/vast-tools/pull/478): fix: Account for pipeline runs with no measurement pairs file 
+- [#478](https://github.com/askap-vast/vast-tools/pull/478): fix: Account for pipeline runs with no measurement pairs file
 - [#483](https://github.com/askap-vast/vast-tools/pull/483): fix: Ensure that full image data does not persist when creating FITS cutouts from compressed HDUs
 - [#480](https://github.com/askap-vast/vast-tools/pull/480): feat: Added open_fits function to handle compressed image HDUs
-- [#476](https://github.com/askap-vast/vast-tools/pull/476): fix: Fixed missing RMS measurements for non-detections 
+- [#476](https://github.com/askap-vast/vast-tools/pull/476): fix: Fixed missing RMS measurements for non-detections
 - [#472](https://github.com/askap-vast/vast-tools/pull/472): fix: Remove duplicates in field matching
 - [#470](https://github.com/askap-vast/vast-tools/pull/470): feat: Added epoch 41
 - [#465](https://github.com/askap-vast/vast-tools/pull/465): feat: Added warning when querying corrected data
-- [#466](https://github.com/askap-vast/vast-tools/pull/466): feat: Added epochs 38, 39 and 40 
+- [#466](https://github.com/askap-vast/vast-tools/pull/466): feat: Added epochs 38, 39 and 40
 - [#463](https://github.com/askap-vast/vast-tools/pull/463): fix: Fix read_selavy to force all flux & flux_err values to be positive
 - [#458](https://github.com/askap-vast/vast-tools/pull/458): feat: Added epoch 37
 - [#453](https://github.com/askap-vast/vast-tools/pull/453): fix: Fix planet matching to correctly handle field names with/without 'A' suffix, and correctly handle empty df in init_sources
@@ -149,7 +166,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - [#421](https://github.com/askap-vast/vast-tools/pull/421): feat, fix, docs: Updated Query._get_epochs to exit nicely when no epochs available & to allow lists and ints to be passed.
 - [#429](https://github.com/askap-vast/vast-tools/pull/429): feat: Added access to epoch 32
 - [#427](https://github.com/askap-vast/vast-tools/pull/427): feat: Added access to epoch 31
-- [#425](https://github.com/askap-vast/vast-tools/pull/425): fix: Bumped pytest and lint github workflow from ubuntu-18.04 -> ubuntu-20.04 
+- [#425](https://github.com/askap-vast/vast-tools/pull/425): fix: Bumped pytest and lint github workflow from ubuntu-18.04 -> ubuntu-20.04
 - [#419](https://github.com/askap-vast/vast-tools/pull/419): feat: Added access to epoch 30
 - [#416](https://github.com/askap-vast/vast-tools/pull/416): fix: Update match_planet_to_field to handle empty groups
 - [#414](https://github.com/askap-vast/vast-tools/pull/414): feat: Added access to epoch 27
@@ -251,7 +268,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - [#258](https://github.com/askap-vast/vast-tools/pull/258): feat: v2.0.0-rc.6
 - [#257](https://github.com/askap-vast/vast-tools/pull/257): fix: Fix lightcurve axist limits for forced fits
 - [#255](https://github.com/askap-vast/vast-tools/pull/255): fix: Added if statement to catch os.getenv returning None
-- [#253](https://github.com/askap-vast/vast-tools/pull/253): feat: Added filter pipeline run by MOC function 
+- [#253](https://github.com/askap-vast/vast-tools/pull/253): feat: Added filter pipeline run by MOC function
 - [#251](https://github.com/askap-vast/vast-tools/pull/251): fix: Check self.pipeline inside write_measurements
 - [#247](https://github.com/askap-vast/vast-tools/pull/247): feat, dep: Updated forced photometry to be a dependency
 - [#246](https://github.com/askap-vast/vast-tools/pull/246): fix: Fixed vaex two epoch metric analysis
@@ -275,5 +292,4 @@ The release candidate 5 of v2.0.0. This was the release before the changelog was
 
 - [#221](https://github.com/askap-vast/vast-tools/pull/221) feat: Pipeline add 2 epoch Mooley style plotting
 - [#220](https://github.com/askap-vast/vast-tools/pull/220) fix: Issue 219 fix source names
-- [#218](https://github.com/askap-vast/vast-tools/pull/218) fix: Removed bad fields from epoch 12 csv 
-
+- [#218](https://github.com/askap-vast/vast-tools/pull/218) fix: Removed bad fields from epoch 12 csv
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 # VAST Tools
-
+[![DOI](https://zenodo.org/badge/199943719.svg)](https://zenodo.org/badge/latestdoi/199943719)
 [![astropy](http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat)](http://www.astropy.org/)
 ![Tests](https://github.com/askap-vast/vast-tools/actions/workflows/pytest.yml/badge.svg)
 [![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://vast-survey.org/vast-tools/)

diff --git a/docs/theme/main.html b/docs/theme/main.html
@@ -34,7 +34,7 @@
       strong{white-space:nowrap}.md-announce}
   </style>
 
-  <a href='{{ base_url }}/changelog/'><strong>Version 3.0.0 released!</strong> Includes access to all pilot survey data, full survey functionality, optimisation and more 🙌 Check the <strong>release notes! 👀</strong></a>
+  <a href='{{ base_url }}/changelog/'><strong>Version 3.0.1 released!</strong> Includes access to all pilot survey data, full survey functionality, optimisation and more 🙌 Check the <strong>release notes! 👀</strong></a>
 
 {% endblock %}