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

use towncrier to handle change log entries and add instructions to new pull requests #187

Merged

Conversation

zacharyburnett
Copy link
Collaborator

@zacharyburnett zacharyburnett commented Sep 10, 2024

new checklist

Tasks

  • update or add relevant tests
  • update relevant docstrings and / or docs/ page
  • 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)
    • run regression tests with this branch installed ("git+https://github.com/<fork>/stpipe@<branch>")
news fragment change types...
  • 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

@zacharyburnett zacharyburnett changed the title use towncrier to handle change log entries use towncrier to handle change log entries and add instructions to new pull requests Sep 10, 2024
@zacharyburnett zacharyburnett self-assigned this Sep 10, 2024
@zacharyburnett zacharyburnett marked this pull request as ready for review September 10, 2024 15:37
@zacharyburnett zacharyburnett requested a review from a team as a code owner September 10, 2024 15:37
Copy link

codecov bot commented Sep 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.29%. Comparing base (5efae61) to head (284d055).
Report is 29 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #187   +/-   ##
=======================================
  Coverage   73.29%   73.29%           
=======================================
  Files          25       25           
  Lines        1917     1917           
=======================================
  Hits         1405     1405           
  Misses        512      512           

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

Copy link
Collaborator

@braingram braingram left a comment

Choose a reason for hiding this comment

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

LGTM.

@zacharyburnett zacharyburnett merged commit 9c3c132 into spacetelescope:main Sep 11, 2024
16 of 17 checks passed
@zacharyburnett zacharyburnett deleted the changelog/towncrier branch September 11, 2024 14:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants