Towncrier demo

CHANGELOG.md

@@ -5,110 +5,49 @@ All changes that impact users of this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-<!---
-This document is intended for users of the applications and API. Changes to things
-like tests should not be noted in this document.
+Towncrier is used to manage this changelog. If you are contributing,
+instead of adding directly to this file, add a fragment in the `changes` directory.
 
-When updating this file for a PR, add an entry for your change under Unreleased
-and one of the following headings:
- - Added - for new features.
- - Changed - for changes in existing functionality.
- - Deprecated - for soon-to-be removed features.
- - Removed - for now removed features.
- - Fixed - for any bug fixes.
- - Security - in case of vulnerabilities.
+<!---
+This document is intended for users of the applications and API. 
+Changes to things like tests and CI should not be noted in this document.
 
-If the heading does not yet exist under Unreleased, then add it as a 3rd heading,
-with three #.
 
+When making a PR, add a one-line file ('fragment')
+to the `changes` directory describing your change,
+in this format: {ISSUE_NUMBER}.{CHANGE_TYPE}.md (1234.change.md).
+See the list of CHANGE_TYPES that ISIS uses below for reference.
+Example for a bugfix (always abbreviated 'fix' in the filename):
 
-When preparing for a public release candidate add a new 2nd heading, with two #, under
-Unreleased with the version number and the release date, in year-month-day
-format. Then, add a link for the new version at the bottom of this document and
-update the Unreleased link so that it compares against the latest release tag.
+    echo 'Fixed `footprintinit` to find mapping group (no caps).' > 5920.fix.md
 
 
-When preparing for a bug fix release create a new 2nd heading above the Fixed
-heading to indicate that only the bug fixes and security fixes are in the bug fix
-release.
--->
+If your change fixes two issues, make multiple fragments with the same line of text.
+If your change is **not related to an issue**, begin the filename with a +, and timestamp it (+20260202113046.fix.md).
+You can use this line to write a timestamped fragment:
 
-## [Unreleased]
+    echo 'Your change description here' > changes/+`date +"%Y%m%d%H%M%S"`.fix.md
 
 
-### Added
-- Added Linux Arm support.
-- Added support for Chandrayaan-2 TMC and OHRC cameras. [#5828](https://github.com/DOI-USGS/ISIS3/pull/5828)
-- Added OFFBODY and OFFBODYTRIM parameters to noproj and cam2cam. Added tests and updated documentation. [#3602](https://github.com/DOI-USGS/ISIS3/issues/3602)
-- Added use Bullet Anaconda feedstock library, which includes double precision support, and fix ISIS use of general Bullet configurations. [#5772](https://github.com/DOI-USGS/ISIS3/pull/5772)
-- Added Mac Arm build support and adjusted the tests appropriately.
-- Added adjusted XYZ point coordinate sigmas to the points.csv jigsaw output file. Modified
-ctest FunctionalTestJigsawApollo to validate this output. [#5710](https://github.com/DOI-USGS/ISIS3/issues/5710)
-- Added support for reading, writing, and viewing GeoTIFFs in ISIS. [#5618](https://github.com/DOI-USGS/ISIS3/pull/5618)
-- Added GDAL SRS propagation for systems outside of ISIS to display projected GTiffs. [#5736](https://github.com/DOI-USGS/ISIS3/pull/5736)
-- Added ale version to history blob. [#5207](https://github.com/DOI-USGS/ISIS3/issues/5207)
-- Added CSM State output capability for jigsaw. [#5609](https://github.com/DOI-USGS/ISIS3/issues/5609)
-- Added ShowDeprecated option to show or hide warnings in IsisPreferences. [#5611](https://github.com/DOI-USGS/ISIS3/issues/5611)
-- Added SpiceQL integration to replace cspice calls. [#5545](https://github.com/DOI-USGS/ISIS3/pull/5545)
-- Added initial `eisstitch` app [#5591](https://github.com/DOI-USGS/ISIS3/pull/5591)
-- Added the ability to disable individual options for parameters in ISIS GUIs [#5849](https://github.com/DOI-USGS/ISIS3/pull/5849)
-- Added PAD or SHRINK options to crop for crops that extend beyond the source image [#5843](https://github.com/DOI-USGS/ISIS3/pull/5843)
-- Added std:: namespace for isinf, fixes build errors for some versions of c++
-- Adds PROJ into ISIS, and exposes the capability with a new class called IProj. [#5317](https://github.com/DOI-USGS/ISIS3/pull/5317)
-- Added `MATCHBANDBIN` option to himos and hicolormos. [#5859](https://github.com/DOI-USGS/ISIS3/issues/5859) and [#5860](https://github.com/DOI-USGS/ISIS3/issues/5860)
-- Added serial number translation for ideal camera [#5662](https://github.com/DOI-USGS/ISIS3/issues/5662)
+Changes are categorized as one of the following CHANGE_TYPES, listed in `towncrier.toml`:
 
-### Changed
-- Removed Arm dependency on xalan-c, as it does not build for now on conda-forge. This requires turning off doc building on Arm. Also changed some variables to avoid name clashes on Arm with clang 16. [#5802](https://github.com/DOI-USGS/ISIS3/pull/5802)
-- Update OSIRIS-REx OCams instrument (Map, Poly, & SamCam) support to current state in UofA code base [#5426](https://github.com/DOI-USGS/ISIS3/issues/5426)
-- Enhanced csminit by removing the need to specify model and plugin [#5585](https://github.com/DOI-USGS/ISIS3/issues/5585)
-- Changed file format to propagate from the input image format to the output image format [#5737](https://github.com/DOI-USGS/ISIS3/pull/5737)
-- Changed `StripPolygonSeeder` and `GridPolygonSeeder` to seed individual polygons within each images multipolygon footprint [#5193](https://github.com/DOI-USGS/ISIS3/issues/5193)
-- Pinned SpiceQL to 1.2.0 [#5852](https://github.com/DOI-USGS/ISIS3/pull/5852)
-- Changed `ControlMeasure` object comparison to no longer factor in creation date for equality [#5862](https://github.com/DOI-USGS/ISIS3/pull/5862)
-- In Application.cpp, converted initialization environmental variable shell commands and file read to c commands. [#5906](https://github.com/DOI-USGS/ISIS3/pull/5906)
-- Improved the Conda Bullet CMAKE configuration in FindBulletFloat64.cmake. Adds the Bullet::Bullet_double target to ALLLIBS. [#5899](https://github.com/DOI-USGS/ISIS3/issues/5899)
-- Changed 'jigsaw' attribute type to account for Linux compiler changes [#5904](https://github.com/DOI-USGS/ISIS3/pull/5904)
-- Updated GDAL to 3.12 and QT to 6.X [#5909](https://github.com/DOI-USGS/ISIS3/pull/5909)
-- Updated cmake configs to accommodate new cspice release [#5886](https://github.com/DOI-USGS/ISIS3/pull/5886)
-- Changed `PVL` class to read data from GDAL metadata directly [#5824](https://github.com/DOI-USGS/ISIS3/pull/5824)
+ - Breaking   (####.break.md)  - for any API-breaking changes (will stay in dev until next major release.).
+ - Added      (####.add.md)    - for new features.
+ - Changed    (####.change.md) - for changes in existing functionality.
+ - Fixed      (####.fix.md)    - for any bug fixes (will be back-ported to most recent LTS).
+ - Security   (####.sec.md)    - for fixes of vulnerabilities.
+ - Deprecated (####.deprec.md) - for soon-to-be removed features.
+ - Removed    (####.rm.md)     - for removed features.
+ - Misc       (####.misc.md)   - for changes that won't be included in the changelog (Tests, CICD, etc...)
 
-### Fixed
-- Fixed Chandrayaan-2 TMC2 serial numbers by setting InstrumentId to CH2_TMC_FORE/NADIR/AFT based on the filename sensor [#5871](https://github.com/DOI-USGS/ISIS3/issues/5871)
-- Fixed kaguyatc2isis invalid BandBin values [#5629](https://github.com/DOI-USGS/ISIS3/issues/5629)
-- Fixed SpiceClient to handle redirect requests.
-- Fixed jigsaw to default OUTADJUSTMENTH5 option to false and allow this feature to run on read-only images [#5700](https://github.com/DOI-USGS/ISIS3/issues/5700)
-- Fixed Cube::fromIsd to add "LineScanTimes" table from HRSC isds [#5668](https://github.com/DOI-USGS/ISIS3/issues/5668)
-- Fixed segfault in SpiceClient when an authentication error was encountered. [#5735](https://github.com/DOI-USGS/ISIS3/pull/5735)
-- Fixed offset and scale not being applied to gdal 32 bit floating point pixels [#5753](https://github.com/DOI-USGS/ISIS3/pull/5753)
-- Fixed `getLocalNormal` not reseting the sample and line [#5752](https://github.com/DOI-USGS/ISIS3/pull/5752)
-- Fixed QView bug that would not allow manual editing of min/max values via the text fields and defaulted to the current min/max type dropdown selection [#5719](https://github.com/DOI-USGS/ISIS3/issues/5719)
-- Fixed Juno Data Area SPKs causing Spiceinit to fail [#5724](https://github.com/DOI-USGS/ISIS3/issues/5724)
-- Fixed embree shapemodel intersection calculation [#5592](https://github.com/DOI-USGS/ISIS3/issues/5592)
-- Fixed findFeaturesSegment.py errors from issues [#5725](https://github.com/DOI-USGS/ISIS3/issues/5725) and [#5702](https://github.com/DOI-USGS/ISIS3/issues/5702)
-- Fixed jigsaw save/apply bug by adding back missing metadata to Instrument Position/Pointing tables [#5701](https://github.com/DOI-USGS/ISIS3/issues/5701)
-- Fixed `StripPolygonSeeder` and `GridPolygonSeeder` memory leaks [#5193](https://github.com/DOI-USGS/ISIS3/issues/5193)
-- Fixed `pointreg` helper function to display deffile to application log [#5806](https://github.com/DOI-USGS/ISIS3/pull/5806)
-- Fixed ISIS Q Applications crashing when opening more than one cube at once. [#5805](https://github.com/DOI-USGS/ISIS3/pull/5805)
-- Fixed csminit docs with more details on the `ISD` and `STATE` pameters [#5790](https://github.com/DOI-USGS/ISIS3/issues/5790)
-- Fixed SpiceQL 1.2.0 API changes [#5846](https://github.com/DOI-USGS/ISIS3/pull/5846)
-- Fixed CSM State String blob not being propagated between input and output cubes [#5847](https://github.com/DOI-USGS/ISIS3/pull/5847)
-- Fixed campt reporting when `ALLOWERROR` is set to true [#5845](https://github.com/DOI-USGS/ISIS3/pull/5845)
-- Fixed order of observer and target in spiceql call in `ctxcal`. [#5823](https://github.com/DOI-USGS/ISIS3/pull/5823)
-- Fixed bundle serialization on MacOS for IPCE [#5808](https://github.com/DOI-USGS/ISIS3/pull/5808)
-- Fixed `noseam` to use correct temporary files when running [#5878](https://github.com/DOI-USGS/ISIS3/pull/5878)
-- Fixed `CubeInfixToPostfix` to safely determine if a known symbol is a function symbol [#5822](https://github.com/DOI-USGS/ISIS3/pull/5822)
-- Fixed `BundleObservationSolveSettings` to properly read empty solve setting xmls [#5822](https://github.com/DOI-USGS/ISIS3/pull/5822)
-- Fixed `footprintinit` to find mapping group (no caps). [#5920](https://github.com/DOI-USGS/ISIS3/pull/5820)
-- Fixed unnecessary un/distortion checks for pixels near the origin. [#5861](https://github.com/DOI-USGS/ISIS3/issues/5861)
-- Fixed the isisStartup scripts for users outside of USGS systems. [#5478](https://github.com/DOI-USGS/ISIS3/issues/5478)
-- Fixed all Q apps not consistently prioritized projction over camera in various tools [#5896](https://github.com/DOI-USGS/ISIS3/issue/5896)
 
-### Removed
-- QT 6 removed MySQL support so MySQL is no longer supported in `isisminer` [#5909](https://github.com/DOI-USGS/ISIS3/pull/5909)
+When maintainers prepare for a release, they should update the version in the `towncrier.toml` config file,
+then run the `towncrier` utility to compile the change fragments into a chagelog section here.
+-->
 
-## [9.0.0] - 09-25-2024
+<!-- towncrier release notes start -->
 
+## [9.0.0] - 2024-09-25
 
 ### Added
 - Added TOVECT output parameter which generate a geospatial CSV file with a VRT metadata sidecar file [#5571](https://github.com/DOI-USGS/ISIS3/issues/5571)  

changes/+6ljbbj.add.md

@@ -0,0 +1 @@
+Added Mac Arm build support and adjusted the tests appropriately.

changes/+fyct91.add.md

@@ -0,0 +1 @@
+Added std:: namespace for isinf, fixes build errors for some versions of c++

changes/+xxrvsq.add.md

@@ -0,0 +1 @@
+Added Linux Arm support.

changes/+zgurup.fix.md

@@ -0,0 +1 @@
+Fixed SpiceClient to handle redirect requests.

changes/.gitignore

@@ -0,0 +1 @@
+!.gitignore

changes/3602.add.md

@@ -0,0 +1 @@
+Added OFFBODY and OFFBODYTRIM parameters to noproj and cam2cam. Added tests and updated documentation.

changes/5193.change.md

@@ -0,0 +1 @@
+Changed `StripPolygonSeeder` and `GridPolygonSeeder` to seed individual polygons within each images multipolygon footprint

changes/5193.fix.md

@@ -0,0 +1 @@
+Fixed `StripPolygonSeeder` and `GridPolygonSeeder` memory leaks

changes/5207.add.md

@@ -0,0 +1 @@
+Added ale version to history blob.

changes/5317.add.md

@@ -0,0 +1 @@
+Adds PROJ into ISIS, and exposes the capability with a new class called IProj.

changes/5426.change.md

@@ -0,0 +1 @@
+Update OSIRIS-REx OCams instrument (Map, Poly, & SamCam) support to current state in UofA code base

changes/5478.fix.md

@@ -0,0 +1 @@
+Fixed the isisStartup scripts for users outside of USGS systems.

changes/5545.add.md

@@ -0,0 +1 @@
+Added SpiceQL integration to replace cspice calls.

changes/5585.change.md

@@ -0,0 +1 @@
+Enhanced csminit by removing the need to specify model and plugin

changes/5591.add.md

@@ -0,0 +1 @@
+Added initial `eisstitch` app

changes/5592.fix.md

@@ -0,0 +1 @@
+Fixed embree shapemodel intersection calculation

changes/5609.add.md

@@ -0,0 +1 @@
+Added CSM State output capability for jigsaw.

changes/5611.add.md

@@ -0,0 +1 @@
+Added ShowDeprecated option to show or hide warnings in IsisPreferences.

changes/5618.add.md

@@ -0,0 +1 @@
+Added support for reading, writing, and viewing GeoTIFFs in ISIS.

changes/5629.fix.md

@@ -0,0 +1 @@
+Fixed kaguyatc2isis invalid BandBin values

changes/5662.add.md

@@ -0,0 +1 @@
+Added serial number translation for ideal camera

changes/5668.fix.md

@@ -0,0 +1 @@
+Fixed Cube::fromIsd to add "LineScanTimes" table from HRSC isds

changes/5700.fix.md

@@ -0,0 +1 @@
+Fixed jigsaw to default OUTADJUSTMENTH5 option to false and allow this feature to run on read-only images

changes/5701.fix.md

@@ -0,0 +1 @@
+Fixed jigsaw save/apply bug by adding back missing metadata to Instrument Position/Pointing tables

changes/5702.fix.md

@@ -0,0 +1 @@
+Fixed findFeaturesSegment.py errors from issues [#5725](https://github.com/DOI-USGS/ISIS3/issues/5725) and

changes/5710.add.md

@@ -0,0 +1 @@
+Added adjusted XYZ point coordinate sigmas to the points.csv jigsaw output file. Modified ctest FunctionalTestJigsawApollo to validate this output.

changes/5719.fix.md

@@ -0,0 +1 @@
+Fixed QView bug that would not allow manual editing of min/max values via the text fields and defaulted to the current min/max type dropdown selection

changes/5724.fix.md

@@ -0,0 +1 @@
+Fixed Juno Data Area SPKs causing Spiceinit to fail

changes/5735.fix.md

@@ -0,0 +1 @@
+Fixed segfault in SpiceClient when an authentication error was encountered.

changes/5736.add.md

@@ -0,0 +1 @@
+Added GDAL SRS propagation for systems outside of ISIS to display projected GTiffs.

changes/5737.change.md

@@ -0,0 +1 @@
+Changed file format to propagate from the input image format to the output image format

changes/5752.fix.md

@@ -0,0 +1 @@
+Fixed `getLocalNormal` not reseting the sample and line

changes/5753.fix.md

@@ -0,0 +1 @@
+Fixed offset and scale not being applied to gdal 32 bit floating point pixels

changes/5772.add.md

@@ -0,0 +1 @@
+Added use Bullet Anaconda feedstock library, which includes double precision support, and fix ISIS use of general Bullet configurations.

changes/5790.fix.md

@@ -0,0 +1 @@
+Fixed csminit docs with more details on the `ISD` and `STATE` pameters

changes/5802.change.md

@@ -0,0 +1 @@
+Removed Arm dependency on xalan-c, as it does not build for now on conda-forge. This requires turning off doc building on Arm. Also changed some variables to avoid name clashes on Arm with clang 16.

changes/5805.fix.md

@@ -0,0 +1 @@
+Fixed ISIS Q Applications crashing when opening more than one cube at once.

changes/5806.fix.md

@@ -0,0 +1 @@
+Fixed `pointreg` helper function to display deffile to application log

changes/5808.fix.md

@@ -0,0 +1 @@
+Fixed bundle serialization on MacOS for IPCE

changes/5822.fix.md

@@ -0,0 +1 @@
+Fixed `BundleObservationSolveSettings` to properly read empty solve setting xmls

changes/5823.fix.md

@@ -0,0 +1 @@
+Fixed order of observer and target in spiceql call in `ctxcal`.

changes/5824.change.md

@@ -0,0 +1 @@
+Changed `PVL` class to read data from GDAL metadata directly

changes/5828.add.md

@@ -0,0 +1 @@
+Added support for Chandrayaan-2 TMC and OHRC cameras.

changes/5843.add.md

@@ -0,0 +1 @@
+Added PAD or SHRINK options to crop for crops that extend beyond the source image

changes/5845.fix.md

@@ -0,0 +1 @@
+Fixed campt reporting when `ALLOWERROR` is set to true

changes/5846.fix.md

@@ -0,0 +1 @@
+Fixed SpiceQL 1.2.0 API changes

changes/5847.fix.md

@@ -0,0 +1 @@
+Fixed CSM State String blob not being propagated between input and output cubes

changes/5849.add.md

@@ -0,0 +1 @@
+Added the ability to disable individual options for parameters in ISIS GUIs

changes/5852.change.md

@@ -0,0 +1 @@
+Pinned SpiceQL to 1.2.0

changes/5859.add.md

@@ -0,0 +1 @@
+Added `MATCHBANDBIN` option to himos and hicolormos.

changes/5860.add.md

@@ -0,0 +1 @@
+Added `MATCHBANDBIN` option to himos and hicolormos.

changes/5861.fix.md

@@ -0,0 +1 @@
+Fixed unnecessary un/distortion checks for pixels near the origin.

changes/5862.change.md

@@ -0,0 +1 @@
+Changed `ControlMeasure` object comparison to no longer factor in creation date for equality

changes/5871.fix.md

@@ -0,0 +1 @@
+Fixed Chandrayaan-2 TMC2 serial numbers by setting InstrumentId to CH2_TMC_FORE/NADIR/AFT based on the filename sensor

changes/5878.fix.md

@@ -0,0 +1 @@
+Fixed `noseam` to use correct temporary files when running

changes/5886.change.md

@@ -0,0 +1 @@
+Updated cmake configs to accommodate new cspice release

changes/5896.fix.md

@@ -0,0 +1 @@
+Fixed all Q apps not consistently prioritized projction over camera in various tools

changes/5899.change.md

@@ -0,0 +1 @@
+Improved the Conda Bullet CMAKE configuration in FindBulletFloat64.cmake. Adds the Bullet::Bullet_double target to ALLLIBS.

changes/5904.change.md

@@ -0,0 +1 @@
+Changed 'jigsaw' attribute type to account for Linux compiler changes

changes/5906.change.md

@@ -0,0 +1 @@
+In Application.cpp, converted initialization environmental variable shell commands and file read to c commands.

changes/5909.change.md

@@ -0,0 +1 @@
+Updated GDAL to 3.12 and QT to 6.X

changes/5909.rm.md

@@ -0,0 +1 @@
+QT 6 removed MySQL support so MySQL is no longer supported in `isisminer`

changes/5920.fix.md

@@ -0,0 +1 @@
+Fixed `footprintinit` to find mapping group (no caps).

changes/5953.misc.md

@@ -0,0 +1 @@
+Added configuration for towncrier changelog utility.

towncrier.toml

@@ -0,0 +1,39 @@
+[tool.towncrier]
+name = "ISIS"
+version = "9.0.0"
+directory = "changes"
+filename = "CHANGELOG.md"
+start_string = "<!-- towncrier release notes start -->\n"
+title_format = "## [{version}] - {project_date}"
+issue_format = "[#{issue}](https://github.com/DOI-USGS/ISIS3/issues/{issue})"
+
+[[tool.towncrier.type]]
+name = "Breaking"
+directory = "break"
+
+[[tool.towncrier.type]]
+name = "Added"
+directory = "add"
+
+[[tool.towncrier.type]]
+name = "Changed"
+directory = "change"
+
+[[tool.towncrier.type]]
+name = "Fixed"
+directory = "fix"
+
+[[tool.towncrier.type]]
+name = "Security"
+directory = "sec"
+
+[[tool.towncrier.type]]
+name = "Deprecated"
+directory = "deprec"
+
+[[tool.towncrier.type]]
+name = "Removed"
+directory = "rm"
+
+
+