DOC release refinements #116
Conversation
| 2. Bump the version defined in ``skops/__init__.py`` | ||
| 3. Git grep for any TODO's that need fixing before the release (e.g. | ||
| 1. Check and update the ``CHANGES.md`` | ||
| 2. For a major release, create a new branch with the name "0.version.X", e.g. |
There was a problem hiding this comment.
Technically, according to semantic versioning, this would be a "minor" release. I think many people use "major" the way you do here, I'm not sure if we want to strictly follow semver.
There was a problem hiding this comment.
Yeah we don't, the whole ecosystem doesn't so I don't think it's a big deal here.
| 5. Create a PR with all the changes and have it reviewed and merged | ||
| 6. Create a tag with the format "v0.version", e.g. "v0.2", and push it to the | ||
| remote repository. Use this tag for releasing the package. If there is a | ||
| minor release under the same branch, it would be "v0.2.1" for example. |
There was a problem hiding this comment.
Numbers below this need to be incremented (6->7 etc.). I think that replacing the numbers with #. numbers them automatically.
Co-authored-by: Benjamin Bossan <BenjaminBossan@users.noreply.github.com>
|
Applied suggestions. |
| 2. For a major release, create a new branch with the name "0.version.X", e.g. | ||
| "0.2.X". This branch will have all tags for all releases under 0.2. | ||
| 3. Bump the version defined in ``skops/__init__.py`` | ||
| 4. Git grep for any TODO's that need fixing before the release (e.g. |
There was a problem hiding this comment.
Can you explain this a little more? Maybe type an example command?
Please ignore if it doesn't make any sense but if I were a new maintainer I might've been confused.
| deprecations) | ||
| 4. Update the ``CHANGES.md`` | ||
| 5. Create a PR with all the changes and have it reviewed and merged |
There was a problem hiding this comment.
Maybe tell them to tag @ skops-dev/maintainers.
There was a problem hiding this comment.
we have this point already in this doc.
| 2. For a major release, create a new branch with the name "0.version.X", e.g. | ||
| "0.2.X". This branch will have all tags for all releases under 0.2. | ||
| 3. Bump the version defined in ``skops/__init__.py`` | ||
| 4. Git grep for any TODO's that need fixing before the release (e.g. |
| deprecations) | ||
| 4. Update the ``CHANGES.md`` | ||
| 5. Create a PR with all the changes and have it reviewed and merged |
There was a problem hiding this comment.
we have this point already in this doc.
Some release process refinements.