Skip to content

Add release process docs #738

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Aug 10, 2020
Merged

Add release process docs #738

merged 1 commit into from
Aug 10, 2020

Conversation

benjeffery
Copy link
Member

@benjeffery benjeffery commented Jul 30, 2020 •
edited
Loading

Fixes #46 and #757

@benjeffery benjeffery added this to the Python 0.3.0 milestone Jul 31, 2020
jeromekelleher
jeromekelleher reviewed Aug 3, 2020
View reviewed changes
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.

LGTM, just needs a fix for beta version numbers.

docs/development.rst Outdated

To make a release first prepare a pull request that sets the correct version
number in ``tskit/_version.py`` following PEP440 format. For a normal release
this should be MAJOR.MINOR.PATCH, for a beta release use MAJOR.MINOR.PATCH.bX.
Copy link
Member

Choose a reason for hiding this comment

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

This should be ``{MAJOR}.{MINOR}.{PATCH}b{X}, e.g. 1.0.0b1.

@benjeffery
Copy link
Member Author

TODO: As part of this update comment in _version.py as mentioned in #736.

@benjeffery
Copy link
Member Author

I've added a comment and corrected the version format in the docs.

@codecov
Copy link

codecov bot commented Aug 10, 2020 •
edited
Loading

Codecov Report

Merging #738 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #738   +/-   ##
=======================================
  Coverage   87.69%   87.69%           
=======================================
  Files          24       24           
  Lines       19387    19387           
  Branches     3640     3640           
=======================================
  Hits        17001    17001           
  Misses       1297     1297           
  Partials     1089     1089
Flag Coverage Δ
#c_tests 85.27% <ø> (ø)
#python_c_tests 90.16% <ø> (ø)
#python_tests 99.02% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
python/tskit/_version.py 100.00% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2447348...7d3db49. Read the comment docs.

jeromekelleher
jeromekelleher approved these changes Aug 10, 2020
View reviewed changes
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.

LGTM

@jeromekelleher jeromekelleher added the AUTOMERGE-REQUESTED Ask Mergify to merge this PR label Aug 10, 2020
@mergify mergify bot merged commit e940ebe into tskit-dev:master Aug 10, 2020
@mergify mergify bot removed the AUTOMERGE-REQUESTED Ask Mergify to merge this PR label Aug 10, 2020
@benjeffery benjeffery mentioned this pull request Aug 10, 2020
Closed
@benjeffery benjeffery deleted the release_docs branch August 27, 2020 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jeromekelleher jeromekelleher jeromekelleher approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Python 0.3.0
Development

Successfully merging this pull request may close these issues.

Document release process
2 participants
@benjeffery @jeromekelleher