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

Merge 0.11 docs with rcs #1752

Merged
merged 1 commit into from
Nov 11, 2024
Merged

Merge 0.11 docs with rcs #1752

merged 1 commit into from
Nov 11, 2024

Conversation

flying-sheep
Copy link
Member

@flying-sheep flying-sheep commented Nov 11, 2024

This would be an idea. It’s pretty manual again and we wanted less manual process. IDK if we can automate this better.

https://scverse.zulipchat.com/#narrow/channel/315185-general/topic/AnnData.200.2E11.2E0/near/481456047

Copy link
Contributor

@ilan-gold ilan-gold left a comment

Choose a reason for hiding this comment

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

Seems doable @flying-sheep but maybe not a huge priority since it only needs to be done on >minor releases. Maybe a python markdown parser + script that runs in the release job?

Copy link
Member

@Zethson Zethson left a comment

Choose a reason for hiding this comment

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

I'm trying to figure out how other big projects seem to do it and if I see it right, they:

  1. Have full release notes per RC -> RC 3 also has all changes of RC2 and RC1 and not just the diff between RCs
  2. The final release has ALL changes and does not mention the RCs again.
  3. If I see this right, packages like numpy, pandas or Pytorch only render non RC releases on their docs but announce the RC changelogs via Github releases.

This PR is fine with me but I just wanted to mention that for discussion.

Copy link

codecov bot commented Nov 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.52%. Comparing base (c168e8d) to head (d7558b3).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1752      +/-   ##
==========================================
- Coverage   86.99%   84.52%   -2.48%     
==========================================
  Files          40       40              
  Lines        6053     6053              
==========================================
- Hits         5266     5116     -150     
- Misses        787      937     +150     

see 8 files with indirect coverage changes

@flying-sheep flying-sheep merged commit 7894073 into main Nov 11, 2024
16 of 21 checks passed
@flying-sheep flying-sheep deleted the docs-rcs branch November 11, 2024 11:18
meeseeksmachine pushed a commit to meeseeksmachine/anndata that referenced this pull request Nov 11, 2024
flying-sheep added a commit that referenced this pull request Nov 11, 2024
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