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

DM-43801: Add towncrier support #101

Merged
merged 10 commits into from
Aug 27, 2024
Merged

DM-43801: Add towncrier support #101

merged 10 commits into from
Aug 27, 2024

Conversation

JeremyMcCormick
Copy link
Collaborator

@JeremyMcCormick JeremyMcCormick commented Aug 27, 2024

  • Added PR template
  • Added CHANGES.rst with hand-written release notes for Felis 27.0.0
  • Added link to changes from index
  • Changed maxdepth of index page toctrees to 1
  • Added README.rst to changes dir (copied from daf_butler)
  • Added the doc fragment type to towncrier config in pyproject.toml
  • Fixed the disable_primary_sidebars page references in documenteer.toml and added metadata to several pages to remove the secondary sidebar

Copy link

codecov bot commented Aug 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.74%. Comparing base (d24166b) to head (10bbe4f).
Report is 11 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #101   +/-   ##
=======================================
  Coverage   90.74%   90.74%           
=======================================
  Files          16       16           
  Lines        1805     1805           
  Branches      386      386           
=======================================
  Hits         1638     1638           
  Misses        101      101           
  Partials       66       66           

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

Copy link
Member

@timj timj left a comment

Choose a reason for hiding this comment

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

One comment. Not sure if it will mean you need to change index.rst.

docs/CHANGES.rst Outdated
@@ -0,0 +1,3 @@
#######
Copy link
Member

Choose a reason for hiding this comment

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

You want this to be an empty files because towncrier is going to add things to the top each time it runs.

docs/CHANGES.rst Outdated
@@ -0,0 +1,35 @@
:html_theme.sidebar_secondary.remove:

Felis 27.0.0
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Felis 27.0.0
Felis 27.0.0 (2024-04-17)

(fixing the line below of course). The date is helpful to give people context.

@JeremyMcCormick JeremyMcCormick merged commit 2ac0db5 into main Aug 27, 2024
15 checks passed
@JeremyMcCormick JeremyMcCormick deleted the tickets/DM-43801 branch August 27, 2024 21:14
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