[SCSB-270] improvements and fixes for build request issue template

[zacharyburnett]

Resolves SCSB-270

Resolves #2378

changes discovered from testing #2374, and review suggestions

[zacharyburnett]

new checklist:

• set the corresponding build milestone for this issue (create it if it doesn't exist)
• add a comment pinging @stscijgbot-rstdms to track this as an RCAL ticket on Jira

freeze and tag code

• Release new versions of STScI-developed dependencies (stcal, stpipe, etc.) if they introduce new bugfixes or features required by the pipeline.
• Ensure pipeline dependencies in pyproject.toml are NOT floating on main (e.g. stcal@git+https://github.com/spacetelescope/stcal.git@main), and instead use PyPI releases (e.g. stcal>=1.19,<2) instead (or, at the very least, point to a specific commit hash). The lower pin does not necessarily need to be the latest release, but rather is based on features / fixes required by the pipeline code.
• add a new line to the DMS Operational Build Versions table in README.md
• IF NOT A PATCH ON AN EXISTING RELEASE, generate new MOC and roman-data-workshop files:
  • run https://github.com/spacetelescope/RegressionTests/actions/workflows/romancal_regtest_gen.yml with:
    • artifactory_truth_directory set to <BUILDNAME>
    • romanisim_script set to romancal_make_l1_data_files.sh
    • romancal_script set to make_moc_rdw_files.sh
  • notify MOC of new files
  • update https://github.com/spacetelescope/roman-data-workshop to point to newly-generated roman-data-workshop files
• Determine the new <VERSION>:
  • if breaking changes are present (changes/*.breaking.rst) increment the major version (1.1.3 -> 2.0.0),
  • else if new features are present increment the minor version (1.1.3 -> 1.2.0),
  • else if only bugfixes are present increment the patch version (1.1.3 -> 1.1.4).
  • If this is a release candidate (indicated above), add an rc1, or rc2, etc. to the end of the version.
• Switch to the release branch corresponding to the minor version, with the micro release as x (1.1.3 -> release/1.1.x).
• IF THIS IS A PATCH ON AN EXISTING RELEASE, duplicate the desired changes (indicated above), onto the desired base revision (indicated above).
• Run towncrier build --version <VERSION> to consume fragments in changes/ into a new entry in CHANGES.rst.
• Tag the head of the release branch with <VERSION>; if this is NOT a patch release (non-diverging branches), ensure the main branch is up-to-date with the latest commit on the release branch.

run "canonical" regression test for metrics dashboard

• On Artifactory (https://bytesalad.stsci.edu), copy a truth file directory to roman-pipeline/build/<BUILDNAME> in order to freeze them. IF THIS IS A PATCH RELEASE it will be the previous build directory roman-pipeline/build/<PREVIOUSBUILDNAME> -> roman-pipeline/build/<BUILDNAME>; otherwise simply copy roman-pipeline/dev -> roman-pipeline/build/<BUILDNAME>.
• Run a regression test with the following parameters, and attach the URL to this issue as a comment:
  • git branch / ref: the <VERSION> tag you just made, e.g. 1.0.1
  • Artifactory truth directory: the truth directory you just copied, e.g. roman-pipeline/build/26Q3_B22.1
  • INT build directory to also upload results to: the build name, e.g. 26Q3_B22.1
• Okify any failures for this regression test run with okify_regtests roman <RUN_NUMBER>. This should be done by a pipeline maintainer.

publish release and deliver frozen environment

• IF NOT A RELEASE CANDIDATE (indicated above), publish a GitHub release for the new version at the tag you just made, using the release notes provided above.
• Write a stasis INI delivery configuration at a publicly accessible URL, e.g. /eng/ssb/websites/ssbpublic/zburnett/ROMANDP-1.0.1-1.ini pointing to romancal[sdp]=1.0.1
• Run stasis, pointing path to stasis input file (.ini) to the URL of the delivery configuration you just wrote.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.81%. Comparing base (740761f) to head (970b66c).
⚠️ Report is 12 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2379      +/-   ##
==========================================
+ Coverage   80.87%   82.81%   +1.93%     
==========================================
  Files         159      131      -28     
  Lines        9531     7243    -2288     
==========================================
- Hits         7708     5998    -1710     
+ Misses       1823     1245     -578     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.