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.

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

DOC release refinements #116

Merged
merged 6 commits into from
Aug 30, 2022
Merged

DOC release refinements #116

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
27eebda
DOC release refinements
adrinjalali Aug 25, 2022
011517b
more
adrinjalali Aug 25, 2022
f9bc104
Update CONTRIBUTING.rst
adrinjalali Aug 26, 2022
8dfca9c
fix numbers
adrinjalali Aug 26, 2022
cb7766c
Merge branch 'release-guide' of github.com:adrinjalali/skops into rel…
adrinjalali Aug 26, 2022
81cf4ae
add git grep
adrinjalali Aug 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 22 additions & 11 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,23 +83,34 @@ Releases are created using `manual GitHub workflows
<https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow>`_.
As a maintainer, follow these steps:

1. Create a new branch
2. Bump the version defined in ``skops/__init__.py``
3. Git grep for any TODO's that need fixing before the release (e.g.
deprecations)
4. Update the ``CHANGES.md``
1. Check and update the ``docs/changes.rst``
2. For a major release, create a new branch with the name "0.version.X", e.g.
Copy link
Collaborator

Choose a reason for hiding this comment

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

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.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah we don't, the whole ecosystem doesn't so I don't think it's a big deal here.

"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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

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.

Copy link
Member Author

Choose a reason for hiding this comment

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

added this.

deprecations). You can do this, for example by:

.. code:: bash

git grep -n TODO


5. Create a PR with all the changes and have it reviewed and merged
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe tell them to tag @ skops-dev/maintainers.

Copy link
Member Author

Choose a reason for hiding this comment

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

we have this point already in this doc.

6. Use the `GitHub action
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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Numbers below this need to be incremented (6->7 etc.). I think that replacing the numbers with #. numbers them automatically.

7. Use the `GitHub action
<https://github.com/skops-dev/skops/actions/workflows/publish-pypi.yml>`__ to
create a new release on **TestPyPI**. Check it for correctness `on test.pypi
<https://test.pypi.org/project/skops/>`_.
7. Use the `GitHub action
8. Use the `GitHub action
<https://github.com/skops-dev/skops/actions/workflows/publish-pypi.yml>`__ to
create a new release on **PyPI**. Check it for correctness `pypi
<https://pypi.org/project/skops/>`_.
8. Create a `new release <https://github.com/skops-dev/skops/releases>`_ on
9. Create a `new release <https://github.com/skops-dev/skops/releases>`_ on
GitHub
9. Update the patch version of the package to a new dev version, e.g. from
10. Update the patch version of the package to a new dev version, e.g. from
``v0.3.0`` to ``v0.3.dev1``
10. Check that the new stable branch of documentation was built correctly on
`readthedocs <https://readthedocs.org/projects/skops/builds/>`_
11. Check that the new stable branch of documentation was built correctly on
`readthedocs <https://readthedocs.org/projects/skops/builds/>`_, and make
sure all relevant releases are *active*.