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 for change log #2144

Merged
merged 7 commits into from
Dec 13, 2022
Merged

Use towncrier for change log #2144

merged 7 commits into from
Dec 13, 2022

Conversation

StFroese
Copy link
Member

@StFroese StFroese commented Dec 1, 2022

closes #1995

@codecov
Copy link

codecov bot commented Dec 1, 2022

Codecov Report

Base: 92.75% // Head: 92.76% // Increases project coverage by +0.00% 🎉

Coverage data is based on head (6b53984) compared to base (0e4ffea).
Patch coverage: 100.00% of modified lines in pull request are covered.

❗ Current head 6b53984 differs from pull request most recent head 383a3c6. Consider uploading reports for the commit 383a3c6 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2144   +/-   ##
=======================================
  Coverage   92.75%   92.76%           
=======================================
  Files         216      216           
  Lines       18050    18045    -5     
=======================================
- Hits        16742    16739    -3     
+ Misses       1308     1306    -2     
Impacted Files Coverage Δ
ctapipe/atmosphere.py 91.40% <ø> (ø)
ctapipe/calib/camera/calibrator.py 95.57% <ø> (ø)
ctapipe/coordinates/nominal_frame.py 89.65% <ø> (ø)
ctapipe/coordinates/telescope_frame.py 90.00% <ø> (ø)
ctapipe/core/container.py 93.02% <ø> (ø)
ctapipe/core/traits.py 93.43% <ø> (ø)
ctapipe/image/reducer.py 92.30% <ø> (ø)
ctapipe/instrument/subarray.py 89.09% <ø> (ø)
ctapipe/instrument/telescope.py 93.18% <ø> (ø)
ctapipe/io/eventsource.py 90.24% <ø> (ø)
... and 5 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Member

@maxnoe maxnoe left a comment

Choose a reason for hiding this comment

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

I am not sure we really need the sub-directories for each submodule.

@StFroese
Copy link
Member Author

StFroese commented Dec 1, 2022

This is just the astropy way of having sections in the change log. I can remove them and write all news fragments in the changes folder

@StFroese StFroese marked this pull request as ready for review December 1, 2022 13:04
@StFroese StFroese force-pushed the towncrier branch 2 times, most recently from 2900b16 to fe9162f Compare December 1, 2022 14:26
@StFroese StFroese requested review from maxnoe and kosack December 1, 2022 14:27
@StFroese StFroese mentioned this pull request Dec 1, 2022
33 tasks
@nbiederbeck
Copy link
Contributor

nbiederbeck commented Dec 1, 2022

I hesitate to review this, because I have no experience with towncrier or any other automatic changelog generation. What would the "Changes: Using towncrier" entry from this PR look like? Can you already include it in this PR?

I assume this PR can already include some developer documentation.

Apropos documentation: The Docs CI is failing.

@StFroese
Copy link
Member Author

StFroese commented Dec 1, 2022

Ctapipe 0.17.1.dev320+gfe9162fe (2022-12-01)    
============================================    
    
    
API Changes    
-----------    
    
    
Bug Fixes    
---------    
    
    
Data Model Changes    
------------------    
    
    
New Feature    
-----------    
    
    
Maintenance    
-----------    
    
- Use towncrier for the generation of change logs [#2144]    
    
    
Refactoring and Optimization    
---------------------------- 

@StFroese
Copy link
Member Author

StFroese commented Dec 1, 2022

Docs also fail on #2138 with the same error

@maxnoe
Copy link
Member

maxnoe commented Dec 1, 2022

Astropy has a CI that checks for the changelog entry or the label "no-changelog-needed".

Can you also add to the docs (or link to the astropy docs if identical) what the maintainers have to do for a new release?

@StFroese
Copy link
Member Author

StFroese commented Dec 1, 2022

Yes I can add it to the readme in the changes folder. It's as simple as towncrier build --version=<VERSION NUMBER>

@StFroese
Copy link
Member Author

StFroese commented Dec 1, 2022

@StFroese
Copy link
Member Author

StFroese commented Dec 1, 2022

The check requires this app https://github.com/Cadair/giles

@StFroese StFroese requested a review from watsonjj as a code owner December 2, 2022 10:39
@StFroese StFroese force-pushed the towncrier branch 2 times, most recently from a6bde48 to 007d54b Compare December 5, 2022 17:25
Copy link
Contributor

@kosack kosack left a comment

Choose a reason for hiding this comment

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

I think now we just need to update the developer guide to explain how to use this. It can go in the making a pull request page (which in any case needs some updating).

ctapipe/utils/fitshistogram.py Outdated Show resolved Hide resolved
docs/changes/README.md Show resolved Hide resolved
nbiederbeck
nbiederbeck previously approved these changes Dec 12, 2022
@StFroese StFroese force-pushed the towncrier branch 2 times, most recently from 2b95392 to 2267488 Compare December 12, 2022 10:24
@StFroese StFroese requested a review from maxnoe December 12, 2022 10:24
nbiederbeck
nbiederbeck previously approved these changes Dec 12, 2022
maxnoe
maxnoe previously approved these changes Dec 12, 2022
@StFroese StFroese dismissed stale reviews from maxnoe and nbiederbeck via 625a2e1 December 13, 2022 14:09
@StFroese StFroese force-pushed the towncrier branch 2 times, most recently from 625a2e1 to 28e2e13 Compare December 13, 2022 14:52
@kosack kosack merged commit 5237cad into master Dec 13, 2022
@maxnoe maxnoe deleted the towncrier branch December 13, 2022 17:10
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.

Setup towncrier for automatic changelog generation
4 participants