Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

mention strun package name usage in docs #1476

Merged
merged 3 commits into from
Dec 4, 2024

Conversation

braingram
Copy link
Collaborator

@braingram braingram commented Oct 28, 2024

Following spacetelescope/stpipe#202 stpipe allows providing a package name to resolve ambiguous aliases provided to strun:

strun romancal::resample ...

This PR adds a note to the docs about when this might be needed.

Link to docs (note is at the end of this section): https://roman-pipeline--1476.org.readthedocs.build/en/1476/roman/pipeline_run.html#from-the-command-line

As the current stpipe required version doesn't support this I'll leave this PR as draft but request reviews for comments on the wording.

This PR makes no code changes so regression tests were not run.

Tasks

  • request a review from someone specific, to avoid making the maintainers review every PR
  • add a build milestone, i.e. 24Q4_B15 (use the latest build if not sure)
  • Does this PR change user-facing code / API? (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)
    • update or add relevant tests
    • update relevant docstrings and / or docs/ page
    • start a regression test and include a link to the running job (click here for instructions)
      • Do truth files need to be updated ("okified")?
        • after the reviewer has approved these changes, run okify_regtests to update the truth files
  • if a JIRA ticket exists, make sure it is resolved properly
news fragment change types...
  • changes/<PR#>.general.rst: infrastructure or miscellaneous change
  • changes/<PR#>.docs.rst
  • changes/<PR#>.stpipe.rst
  • changes/<PR#>.associations.rst
  • changes/<PR#>.scripts.rst
  • changes/<PR#>.mosaic_pipeline.rst
  • changes/<PR#>.patch_match.rst

steps

  • changes/<PR#>.dq_init.rst
  • changes/<PR#>.saturation.rst
  • changes/<PR#>.refpix.rst
  • changes/<PR#>.linearity.rst
  • changes/<PR#>.dark_current.rst
  • changes/<PR#>.jump_detection.rst
  • changes/<PR#>.ramp_fitting.rst
  • changes/<PR#>.assign_wcs.rst
  • changes/<PR#>.flatfield.rst
  • changes/<PR#>.photom.rst
  • changes/<PR#>.flux.rst
  • changes/<PR#>.source_detection.rst
  • changes/<PR#>.tweakreg.rst
  • changes/<PR#>.skymatch.rst
  • changes/<PR#>.outlier_detection.rst
  • changes/<PR#>.resample.rst
  • changes/<PR#>.source_catalog.rst

@github-actions github-actions bot added documentation Improvements or additions to documentation pipeline labels Oct 28, 2024
@braingram braingram requested a review from schlafly October 28, 2024 13:22
Copy link
Collaborator

@schlafly schlafly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Copy link

codecov bot commented Oct 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.77%. Comparing base (573d961) to head (814815f).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1476   +/-   ##
=======================================
  Coverage   76.77%   76.77%           
=======================================
  Files         118      118           
  Lines        7747     7747           
=======================================
  Hits         5948     5948           
  Misses       1799     1799           

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

@braingram braingram mentioned this pull request Nov 12, 2024
10 tasks
@braingram braingram force-pushed the strun_package_name branch 2 times, most recently from 81d8b05 to f79f88b Compare November 26, 2024 15:55
Copy link
Collaborator

@mairanteodoro mairanteodoro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@braingram braingram marked this pull request as ready for review December 4, 2024 22:04
@braingram braingram requested a review from a team as a code owner December 4, 2024 22:04
@github-actions github-actions bot added the dependencies Pull requests that update a dependency file label Dec 4, 2024
@braingram
Copy link
Collaborator Author

I brought this out of draft since now stpipe main has changes (spacetelescope/stpipe#195) useful to romancal.

I updated this PR to point to stpipe main and started regtests here:
https://github.com/spacetelescope/RegressionTests/actions/runs/12169143665

@braingram
Copy link
Collaborator Author

Regtests all passed so merging.

@braingram braingram merged commit fa457d9 into spacetelescope:main Dec 4, 2024
30 checks passed
@braingram braingram deleted the strun_package_name branch December 4, 2024 23:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation pipeline
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants