Update changlog CI to use a pre-built workflow. (#233)

* Update changlog CI to use a pre-built workflow. * Apply suggestions from code review Co-authored-by: Zach Burnett <zachary.r.burnett@gmail.com> * update title levels for older changlog entries --------- Co-authored-by: Zach Burnett <zachary.r.burnett@gmail.com> Co-authored-by: Zach Burnett <zburnett@stsci.edu>
spacetelescope · Dec 6, 2023 · 5756fda · 5756fda
1 parent 0971248
commit 5756fda
Show file tree

Hide file tree

Showing 2 changed files with 82 additions and 5 deletions.
diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml
@@ -4,13 +4,21 @@ on:
   pull_request:
     types: [labeled, unlabeled, opened, synchronize, reopened]
 
+# Only cancel in-progress jobs or runs for the current workflow
+#   This cancels the already triggered workflows for a specific PR without canceling
+#   other instances of this workflow (other PRs, scheduled triggers, etc) when something
+#   within that PR re-triggers this CI
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   ensure_changelog:
     name: Verify that a changelog entry exists for this pull request
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: true
-      - run: grep -P '\[[^\]]*#${{github.event.number}}[,\]]' CHANGES.rst
-        if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-changelog-entry-needed') }}
+    - uses: scientific-python/action-check-changelogfile@0.2
+      env:
+        CHANGELOG_FILENAME: CHANGES.rst
+        CHECK_MILESTONE: false
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -269,6 +269,9 @@ Other
 1.3.4 (2023-02-13)
 ==================
 
+Bug Fixes
+---------
+
 ramp_fitting
 ~~~~~~~~~~~~
 
@@ -480,6 +483,9 @@ general
 0.7.3 (2022-05-20)
 ==================
 
+Bug Fixes
+---------
+
 jump
 ~~~~
 
@@ -493,6 +499,9 @@ ramp_fitting
 0.7.2 (2022-05-19)
 ==================
 
+Bug Fixes
+---------
+
 ramp_fitting
 ~~~~~~~~~~~~
 
@@ -503,13 +512,19 @@ ramp_fitting
 0.7.1 (2022-05-16)
 ==================
 
+Bug Fixes
+---------
+
 jump
 ~~~~
 - Enable multiprocessing for jump detection, which is controlled by the 'max_cores' parameter. [#87]
 
 0.7.0 (2022-05-13)
 ==================
 
+Bug Fixes
+---------
+
 linearity
 ~~~~~~~~~
 - Added functionality to linearly process ZEROFRAME data the same way
@@ -530,6 +545,9 @@ saturation
 0.6.4 (2022-05-02)
 ==================
 
+Bug Fixes
+---------
+
 saturation
 ~~~~~~~~~~
 
@@ -538,6 +556,9 @@ saturation
 0.6.3 (2022-04-27)
 ==================
 
+Bug Fixes
+---------
+
 - Pin astropy min version to 5.0.4. [#82]
 
 - Fix for jumps in first good group after dropping groups [#84]
@@ -546,6 +567,9 @@ saturation
 0.6.2 (22-03-29)
 ================
 
+Bug Fixes
+---------
+
 jump
 ~~~~
 - Neighboring pixels with 'SATURATION' or 'DONOTUSE' flags are no longer flagged as jumps. [#79]
@@ -559,6 +583,9 @@ ramp_fitting
 0.6.1 (22-03-04)
 ================
 
+Bug Fixes
+---------
+
 ramp_fitting
 ~~~~~~~~~~~~
 
@@ -568,6 +595,9 @@ ramp_fitting
 0.6.0 (22-01-14)
 ================
 
+Bug Fixes
+---------
+
 ramp_fitting
 ~~~~~~~~~~~~
 
@@ -583,6 +613,9 @@ jump
 0.5.1 (2022-01-07)
 ==================
 
+Bug Fixes
+---------
+
 jump
 ~~~~
 
@@ -593,6 +626,9 @@ jump
 0.5.0 (2021-12-28)
 ==================
 
+Bug Fixes
+---------
+
 dark_current
 ~~~~~~~~~~~~
 
@@ -601,6 +637,9 @@ dark_current
 0.4.3 (2021-12-27)
 ==================
 
+Bug Fixes
+---------
+
 linearity
 ~~~~~~~~~
 - Let software set the pixel dq flag to NO_LIN_CORR if linear term of linearity coefficient is zero. [#65]
@@ -618,6 +657,9 @@ ramp_fitting
 0.4.2 (2021-10-28)
 ==================
 
+Bug Fixes
+---------
+
 ramp_fitting
 ~~~~~~~~~~~~
 
@@ -629,6 +671,9 @@ ramp_fitting
 0.4.1 (2021-10-14)
 ==================
 
+Bug Fixes
+---------
+
 jump_detection
 ~~~~~~~~~~~~~~
 
@@ -638,6 +683,9 @@ jump_detection
 0.4.0 (2021-10-13)
 ==================
 
+Bug Fixes
+---------
+
 jump_detection
 ~~~~~~~~~~~~~~
 
@@ -656,6 +704,9 @@ ramp_fitting
 0.3.0 (2021-09-28)
 ==================
 
+Bug Fixes
+---------
+
 saturation
 ~~~~~~~~~~
 
@@ -665,6 +716,9 @@ saturation
 0.2.5 (2021-08-27)
 ==================
 
+Bug Fixes
+---------
+
 jump
 ~~~~
 
@@ -678,12 +732,18 @@ ramp_fitting
 0.2.4 (2021-08-26)
 ==================
 
+Bug Fixes
+---------
+
 Workaround for setuptools_scm issues with recent versions of pip. [#45]
 
 
 0.2.3 (2021-08-06)
 ==================
 
+Bug Fixes
+---------
+
 jump
 ~~~~
 - documentation changes + docs for jump detection [#14]
@@ -697,6 +757,9 @@ ramp_fitting
 0.2.2 (2021-07-19)
 ==================
 
+Bug Fixes
+---------
+
 jump
 ~~~~
 
@@ -712,6 +775,9 @@ ramp_fitting
 0.2.1 (2021-05-20)
 ==================
 
+Bug Fixes
+---------
+
 ramp_fitting
 ~~~~~~~~~~~~
 
@@ -721,6 +787,9 @@ ramp_fitting
 0.2.0 (2021-05-18)
 ==================
 
+Bug Fixes
+---------
+
 ramp_fitting
 ~~~~~~~~~~~~