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

Version 0.2.0 Release #146

Merged
merged 1 commit into from
Mar 7, 2024
Merged

Version 0.2.0 Release #146

merged 1 commit into from
Mar 7, 2024

Conversation

daikitag
Copy link
Collaborator

@daikitag daikitag commented Mar 6, 2024

Update the changelog for version0.2.0 release

Copy link

codecov bot commented Mar 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (21b2bc5) to head (33cf5e9).

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #146   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            8         8           
  Lines          351       351           
  Branches        50        50           
=========================================
  Hits           351       351           

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

@daikitag
Copy link
Collaborator Author

daikitag commented Mar 6, 2024

@jeromekelleher Would it be possible for you to check the changelog for me? If it looks good, I will update the date of the version 0.2.0 in this document, and I hope that we can release the new version soon.

@daikitag daikitag modified the milestone: 0.0.2 release Mar 6, 2024
@daikitag
Copy link
Collaborator Author

daikitag commented Mar 7, 2024

Sorry, it is version 0.1.0, not 0.2.0. However, I think we can actually make the new release as version 1.0.0, as we had validated the proporties of tstrait, many new functionalities are added to implement the simulation frameworks of other external simulators, and I feel that this is the complete package now. Do you have any thoughts on this?

Copy link
Member

@jeromekelleher jeromekelleher left a comment

Choose a reason for hiding this comment

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

Looks good. I don't think listing out the URLs is an improvement, and you need to be a bit clearer about the breaking status.

I think version 1.0.0 is quite premature (consider how many versions msprime went through before 1.0)

CHANGELOG.md Outdated

### Documentation:

- Create infrastructure for documentation {pr}`77`
- Build initial documentation {pr}`78`
- Add Changelog to documentation {pr}`79`
Copy link
Member

Choose a reason for hiding this comment

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

Why are you replacing these? the {pr}73 should get interpreted by jupyter book and substituted correctly. If not, the jupyterbook config needs some tweaking

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I looked up the tstrait website, and it seems that {pr} is working, so I modified it just now.

CHANGELOG.md Outdated

### Contributors:

- Jerome Kelleher
Copy link
Member

Choose a reason for hiding this comment

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

Order these alphabetically?

Copy link
Member

Choose a reason for hiding this comment

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

GitHub will do this anyway, so there's no need to list out the contributors I think (unless you want to)

## [0.1.0] - 2024-03-XX

### Changes from Version 0.0.1:

Copy link
Member

Choose a reason for hiding this comment

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

I think you need to make it clearer that this is a breaking change release. What code written using the 0.0.1 version would now break, and what should users do about it?

@daikitag
Copy link
Collaborator Author

daikitag commented Mar 7, 2024

I fixed it now, so would it be possible for you to check it again @jeromekelleher ?

@daikitag daikitag mentioned this pull request Mar 7, 2024
Update the changelog for version0.1.0 release
@mergify mergify bot merged commit 7aa0cb4 into tskit-dev:main Mar 7, 2024
12 checks passed
@daikitag daikitag deleted the version01-update branch March 7, 2024 14:36
@daikitag daikitag restored the version01-update branch March 8, 2024 14:18
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