Skip to content

Commit

Permalink
Merge branch 'main' into conv_kernel_model
Browse files Browse the repository at this point in the history
  • Loading branch information
penaguerrero authored Sep 13, 2024
2 parents f7765d0 + 738e14c commit d1c67da
Show file tree
Hide file tree
Showing 18 changed files with 82 additions and 33 deletions.
22 changes: 16 additions & 6 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,19 @@ Closes #
<!-- describe the changes comprising this PR here -->
This PR addresses ...

**Checklist**
- [ ] added entry in `CHANGES.rst` (either in `Bug Fixes` or `Changes to API`)
- [ ] updated relevant tests
- [ ] updated relevant documentation
- [ ] updated relevant milestone(s)
- [ ] added relevant label(s)
<!-- if you can't perform these tasks due to permissions, please ask a maintainer to do them -->
## Tasks
- [ ] update or add relevant tests
- [ ] update relevant docstrings and / or `docs/` page
- [ ] Does this PR change any API used downstream? (if not, label with `no-changelog-entry-needed`)
- [ ] write news fragment(s) in `changes/`: `echo "changed something" > changes/<PR#>.<changetype>.rst` (see below for change types)
- [ ] [run `jwst` regression tests](https://github.com/spacetelescope/RegressionTests/actions/workflows/jwst.yml) with this branch installed (`"git+https://github.com/<fork>/stdatamodels@<branch>"`)

<details><summary>news fragment change types...</summary>

- ``changes/<PR#>.feature.rst``: new feature
- ``changes/<PR#>.bugfix.rst``: fixes an issue
- ``changes/<PR#>.doc.rst``: documentation change
- ``changes/<PR#>.removal.rst``: deprecation or removal of public API
- ``changes/<PR#>.misc.rst``: infrastructure or miscellaneous change
</details>
30 changes: 22 additions & 8 deletions .github/workflows/changelog.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,30 @@
name: Ensure changelog
name: changelog

on:
pull_request:
types: [labeled, unlabeled, opened, synchronize, reopened]
types:
- labeled
- unlabeled
- opened
- synchronize
- reopened

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
ensure_changelog:
name: Verify that a changelog entry exists for this pull request
check:
if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-changelog-entry-needed') }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v5
with:
python-version: 3
- uses: actions/checkout@v4
with:
submodules: true
- run: grep -P '\[[^\]]*#${{github.event.number}}[,\]]' CHANGES.rst
if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-changelog-entry-needed') }}
fetch-depth: 0
- run: pip install .
- run: pip install towncrier
- run: towncrier check
- run: towncrier build --draft | grep -P '#${{ github.event.number }}'
3 changes: 3 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ build:
os: "ubuntu-22.04"
tools:
python: mambaforge-4.10
jobs:
post_install:
- towncrier build --keep

conda:
environment: docs/rtd_environment.yaml
Expand Down
17 changes: 0 additions & 17 deletions CHANGES.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,3 @@
2.0.1 (unreleased)
===================

- replace usages of ``copy_arrays`` with ``memmap`` [#306]

- Remove deprecated ``R_DRIZPAR`` keyword from core schema
as well as ``jwst.datamodels.DrizParsModel``. [#316]

- Add ``mt_v2`` and ``mt_v3`` keywords to ``moving_target`` schema [#263]

- add grating keyword to dark and superbias schemas [#317]

- remove uses of now unused ``ignore_version_mismatch`` [#313]

- Added ``MEDIUMDEEP2`` and ``MEDIUMDEEP8`` to allowed readout patterns
in JWST core schema, ``READPATT``, and ``PREADPATT``. [#315]

2.0.0 (2024-06-24)
===================

Expand Down
1 change: 1 addition & 0 deletions changes/.gitkeep
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

1 change: 1 addition & 0 deletions changes/263.feature.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add ``mt_v2`` and ``mt_v3`` keywords to ``moving_target`` schema
1 change: 1 addition & 0 deletions changes/306.removal.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
replace usages of ``copy_arrays`` with ``memmap``
1 change: 1 addition & 0 deletions changes/313.removal.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
remove uses of now unused ``ignore_version_mismatch``
1 change: 1 addition & 0 deletions changes/315.feature.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added ``MEDIUMDEEP2`` and ``MEDIUMDEEP8`` to allowed readout patterns in JWST core schema, ``READPATT``, and ``PREADPATT``.
1 change: 1 addition & 0 deletions changes/316.removal.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Remove deprecated ``R_DRIZPAR`` keyword from core schema as well as ``jwst.datamodels.DrizParsModel``.
1 change: 1 addition & 0 deletions changes/317.feature.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
add grating keyword to dark and superbias schemas
1 change: 1 addition & 0 deletions changes/319.feature.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update JWST datamodel ``irs2`` datatype to provide ``numpy>=2.0`` compatibility.
1 change: 1 addition & 0 deletions changes/326.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
use ``towncrier`` to handle change log entries
1 change: 1 addition & 0 deletions docs/rtd_environment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ dependencies:
- pip
- graphviz
- sphinx_rtd_theme>1.2.0
- towncrier
5 changes: 5 additions & 0 deletions docs/source/changes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
***********
Change Log
***********

.. include:: ../../CHANGES.rst
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Welcome to stdatamodels's documentation!
:caption: Contents:

asdf_in_fits.rst
changes.rst

JWST
====
Expand Down
23 changes: 23 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -153,3 +153,26 @@ write_to = "src/stdatamodels/_version.py"
omit = [
'*/tests/*',
]

[tool.towncrier]
filename = "CHANGES.rst"
directory = "changes"
package = "stdatamodels"
title_format = "{version} ({project_date})"
ignore = [".gitkeep"]
wrap = true
issue_format = "`#{issue} <https://github.com/spacetelescope/stdatamodels/issues/{issue}>`_"

[tool.towncrier.fragment.feature]
name = "New Features"

[tool.towncrier.fragment.bugfix]
name = "Bug Fixes"

[tool.towncrier.fragment.doc]
name = "Documentation"

[tool.towncrier.fragment.removal]
name = "Deprecations and Removals"

[tool.towncrier.fragment.misc]
4 changes: 2 additions & 2 deletions src/stdatamodels/jwst/datamodels/schemas/irs2.schema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ allOf:
fits_hdu: DQ
datatype:
- name: OUTPUT
datatype: uint8
datatype: uint16
- name: ODD_EVEN
datatype: uint8
datatype: uint16
- name: MASK
datatype: uint32

0 comments on commit d1c67da

Please sign in to comment.