How to make a new release of ``skimage``
========================================
While following this guide, note down all the times that you need to
consult a previous release manager, or that you find an instruction
unclear. You will, of course, make a PR to update these notes after
you are done with the release! ;-)
Before you start, make sure you have all the required write
permissions (if not, you will need to ask an owner to grant you
access), specifically to:
- https://pypi.org/project/scikit-image/
- https://github.com/scikit-image/scikit-image-web
- Check ``TODO.txt`` for any outstanding tasks.
We use a variant of "semantic versioning", where version numbers are classified
as v<major>.<minor>.<patch>. By default, releases are made from the main
branch as part of a linear release history and, as described below, are
triggered by pushing a git tag to the scikit-image repository on github. If
a patch release is required for an older version, a branch can be created from
the appropriate point in main and the following instructions are still apt.
- Update the release notes (note this will soon change with the addition of
Towncrier integrated directly into the CI):
1. Review and cleanup ``doc/release/release_dev.rst``.
2. Make a list of merges, contributors, and reviewers by running
``tools/generate_release_notes.py -h`` and following that file's usage.
3. Paste this list at the end of the ``release_dev.txt``.
4. Scan the PR titles for highlights, deprecations, API changes,
and bugfixes, and mention these in the relevant sections of the notes.
Try to present the information in an expressive way by mentioning
the affected functions, elaborating on the changes and their
consequences. If possible, organize semantically close PRs in groups.
5. Check for duplicate names in the automatically generated list of
contributors and reviewers
6. Rename the file to ``doc/release/release_<major>.<minor>.txt``
7. Copy ``doc/release/release_template.txt`` to
``doc/release/release_dev.txt`` for the next release.
8. Copy relevant deprecations from ``release_<major>_<minor>.txt``
to ``release_dev.txt``.
9. Update the file ``skimage/data/_fetchers.py`` to point the pooch
repository to the new branch instead of main during testing.
Look for the parameter ``version_dev="main",`` for ``pooch.create`` and
change it to the newly created branch name.
- Submit the release notes for review by other project maintainers:
- Create a PR from v<major>.<minor>.x branch to `main` (at this point,
the difference should show the full contents of the release notes).
- Discuss with others, and make the changes directly to v<major>.<minor>.x branch.
- Once the consensus is found, ask the project maintainers to merge
the PR.
- Cherry pick the change onto the release branch.
- On the main branch, update the version number in ``skimage/__init__.py``
to the next ``.dev0`` version, commit, and push. This should follow PEP440
meaning that the appropriate version number would look something like
``0.20.0.dev0`` with the period between ``0`` and ``dev`` and a trailing
``0`` immediately after ``dev``. The final ``0`` is necessary to ensure
that
`NumpyVersion <https://github.com/scikit-image/scikit-image/pull/4947>`_
correctly interprets the version number.
- To debug building and testing wheels via CI, push to a branch named
`maintenance/anything`.
Once everything works as intended, remove those branches and proceed.
- Edit ``doc/source/_static/docversions.js`` and
``doc/source/_static/version_switcher.json`` in order to
add the release, e.g., `0.15.x`, and commit.
- Update the version number to stable in ``skimage/__init__.py``, and commit.
- Make a release. You may wish to iterate initially with release candidates in
the steps below (add rc along with a number to the end of the tag version).
1. Add the version number as a tag in git::
git tag -s -m <github_release_message> [-u <key-id>] v<major>.<minor>.0
(If you do not have a GPG key, follow the tutorial to set it up:
https://help.github.com/articles/signing-commits-with-gpg/)
2. Push the new tag to GitHub::
git push upstream v<major>.<minor>.<patch>
(where ``upstream`` is the name of the
``github.com:scikit-image/scikit-image`` repository.)
Pushing the version tag will (for details see .github/workflows/wheel_tests_and_release.yml):
1. Build and upload the wheels to PyPI
2. Publish the source distribution on PyPi
3. Publish the release on github
- Once the release is completed you should update the release docs:
- Edit ``doc/source/_static/docversions.js`` and commit
- On the release branch, build a clean version of the docs. In the
root directory, run ``pip install .``.
- In the ``doc/`` directory:
- Build using
``make clean; make html; make gh-pages``.
- Check (since this a new feature) that binder links in gallery examples
point to the release branch, e.g. `0.16.x`.
- In the ``gh-pages/`` directory:
- Update the symlink to ``stable`` and commit.
- Upload the docs: ``git push origin gh-pages`` in ``doc/gh-pages``.
- Update the web frontpage:
The webpage source is kept in a separate repo: `scikit-image-web`.
- Add release date to ``index.rst`` under "News".
- Add previous stable version documentation path to disallowed paths
in `robots.txt`
- Commit and push (this will also build and update the website).
- Post release notes on user & dev forums, blog, Twitter, etc.
- https://forum.image.sc/tag/scikit-image
- https://discuss.scientific-python.org/c/contributor/skimage
- scipy-user@python.org
- scikit-learn@python.org
- Update the version and the release date on Wikipedia
https://en.wikipedia.org/wiki/Scikit-image
- Make a PR to scikit-image with any updates you might have to these notes
- If making a patch release (v<major>.<minor>.<patch>), forward-port the
release notes to the main branch and make a PR.
Conda-forge
-----------
**Note**: conda-forge now has an automated bot who makes the below PR for you.
Now all you have to do is to look at pull requests at
https://github.com/conda-forge/scikit-image-feedstock/pulls
and check for a new one for this version. Wait for all the continuous
integration checks to go green, then merge.
The manual instructions remain below in case the bot fails for some reason.
A scikit-image build recipe resides at
https://github.com/conda-forge/scikit-image-feedstock. You should update it to
point to the most recent release. You can do this by following these steps:
- Fork the repository at https://github.com/conda-forge/scikit-image-feedstock,
and clone it to your machine.
- Sprout a new branch, e.g. ``v<major>.<minor>``.
- Find out the SHA256 hash of the source distribution. You can find this at
https://pypi.org/project/scikit-image/, or use the following commands:
- ``sha256sum path/to/scikit-image-*.tar.gz`` (Linux)
- ``shasum -a 256 dist/scikit-image-*.tar.gz`` (macOS)
- ``CertUtil -hashfile dist\scikit-image-*.tar.gz SHA256`` (Windows)
- Edit the file ``recipe/meta.yaml``:
- Update the version number on the first line.
- Update the SHA256 value on line 9.
- If necessary, reset the build number to 0. (line 12)
- Update any requirements in the appropriate sections (build or run).
Note: don't remove ``numpy x.x``. This tells conda-smithy, conda-forge's
build system, that the library must be linked against NumPy at build time.
- Commit these changes.
- Update the infrastructure around the recipe with ``conda-smithy``:
* Install conda-smithy either with conda or pip
* Run ``conda-smithy rerender`` in the root of the repository, and commit
the changes.
- Push to your fork, and submit a pull request to the
upstream repo.
Debian
------
The below instructions remain here for completeness. However
没有合适的资源?快使用搜索试试~ 我知道了~
scikit-image-0.21.0.tar.gz
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
5星 · 超过95%的资源 2 下载量 21 浏览量
2023-07-11
17:29:43
上传
评论
收藏 21.67MB GZ 举报
温馨提示
共938个文件
py:536个
rst:74个
npy:54个
该资源为scikit_image-0.21.0.tar.gz,欢迎下载使用哦!
资源推荐
资源详情
资源评论
收起资源包目录
scikit-image-0.21.0.tar.gz (938个子文件)
make.bat 3KB
CITATION.bib 1KB
meson.build 4KB
meson.build 3KB
meson.build 2KB
meson.build 1KB
meson.build 1KB
meson.build 1KB
meson.build 1KB
meson.build 924B
meson.build 914B
meson.build 841B
meson.build 759B
meson.build 752B
meson.build 702B
meson.build 642B
meson.build 641B
meson.build 530B
meson.build 489B
meson.build 439B
meson.build 428B
meson.build 426B
meson.build 425B
meson.build 403B
meson.build 395B
meson.build 370B
meson.build 366B
meson.build 353B
meson.build 346B
meson.build 340B
meson.build 330B
meson.build 320B
meson.build 310B
meson.build 289B
meson.build 270B
meson.build 251B
meson.build 249B
meson.build 237B
meson.build 226B
meson.build 218B
meson.build 183B
meson.build 163B
meson.build 151B
meson.build 143B
unwrap_3d_ljmu.c 47KB
unwrap_2d_ljmu.c 25KB
MarchingCubes.cpp 44KB
theme_overrides.css 637B
multi.fits 264KB
simple.fits 135KB
no_time_for_that_tiny.gif 4KB
.gitignore 858B
LookUpTable.h 155KB
fast_exp.h 1KB
conditional_omp.h 666B
unwrap_3d_ljmu.h 296B
unwrap_2d_ljmu.h 254B
favicon.ico 15KB
_skeletonize_3d_cy.pyx.in 15KB
pyproject.toml.in 4KB
MANIFEST.in 661B
git_links.inc 4KB
git_links.inc 3KB
known_projects.inc 1KB
known_projects.inc 1KB
this_project.inc 230B
links.inc 113B
links.inc 113B
this_project.inc 101B
matplotlib_plugin.ini 123B
tifffile_plugin.ini 110B
simpleitk_plugin.ini 92B
pil_plugin.ini 91B
gdal_plugin.ini 89B
imageio_plugin.ini 88B
fits_plugin.ini 88B
imread_plugin.ini 86B
hubble_deep_field.jpg 516KB
retina.jpg 263KB
rocket.jpg 110KB
elevation_map.jpg 74KB
truncated.jpg 400B
docversions.js 898B
version_switcher.json 2KB
asv.conf.json 596B
LICENSE 1KB
Makefile 4KB
Makefile 3KB
link-version-pyinit.map 32B
core_developer.md 11KB
code_of_conduct.md 8KB
README_CI.md 8KB
values.md 4KB
glossary.md 4KB
README.md 2KB
meson.md 2KB
README.md 622B
README.md 454B
index.md 258B
CODE_OF_CONDUCT.md 68B
共 938 条
- 1
- 2
- 3
- 4
- 5
- 6
- 10
资源评论
- 小呆呆8982024-01-11资源很赞,希望多一些这类资源。
- dianzixinxisizi2024-03-05总算找到了自己想要的资源,对自己的启发很大,感谢分享~
假技术po主
- 粉丝: 515
- 资源: 4199
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功