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

add CI check that CHANGES.rst is not modified #1412

Merged
merged 2 commits into from
Sep 17, 2024

Conversation

braingram
Copy link
Collaborator

@braingram braingram commented Sep 17, 2024

Add a CI check to make sure PRs don't change CHANGES.rst. Changelog entries now take the form of towncrier fragments and manual edits to CHANGES.rst are no longer needed.

Here's a run of the new check that fails (due to an edit to CHANGES.rst added temporarily to this PR): https://github.com/spacetelescope/romancal/actions/runs/10906504272/job/30267904518?pr=1412

Checklist

  • for a public change, added a towncrier news fragment in changes/

    echo "changed something" > changes/<PR#>.<changetype>.rst

    • 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
  • updated relevant tests

  • updated relevant documentation

  • updated relevant milestone(s)

  • added relevant label(s)

  • ran regression tests, post a link to the Jenkins job below. How to run regression tests on a PR

@braingram braingram force-pushed the no_changes_change branch 3 times, most recently from 11e0a91 to aa79163 Compare September 17, 2024 15:39
@braingram braingram force-pushed the no_changes_change branch 2 times, most recently from aa79163 to a9ceee8 Compare September 17, 2024 15:47
@braingram braingram marked this pull request as ready for review September 17, 2024 15:47
@braingram braingram requested a review from a team as a code owner September 17, 2024 15:47
@braingram
Copy link
Collaborator Author

Thanks! It doesn't look like I have permissions to update the branch protections but I think it makes sense to make changelog / no_changelog_edit required.

Copy link

codecov bot commented Sep 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.52%. Comparing base (cef755e) to head (0746f70).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1412   +/-   ##
=======================================
  Coverage   78.52%   78.52%           
=======================================
  Files         117      117           
  Lines        7833     7833           
=======================================
  Hits         6151     6151           
  Misses       1682     1682           
Flag Coverage Δ *Carryforward flag
nightly 62.24% <ø> (ø) Carriedforward from cef755e

*This pull request uses carry forward flags. Click here to find out more.

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

@schlafly
Copy link
Collaborator

Is there a way to extend the message name / user readable portion so that we say something like "use towncrier" or something? If it's not easy, then forget it.

@braingram
Copy link
Collaborator Author

Thanks @schlafly how's changelog / uses_towncrier?

@schlafly
Copy link
Collaborator

That sounds good to me. Maybe changelog_uses_towncrier so it's clear that the changelog is the problem, and that using towncrier is the answer? Anyway, I'll defer to you, looks good, thanks.

@braingram braingram merged commit 93f1cec into spacetelescope:main Sep 17, 2024
27 checks passed
@braingram braingram deleted the no_changes_change branch September 17, 2024 17:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants