From 56fb754f6f167dd972f89c64899c9672d3e98847 Mon Sep 17 00:00:00 2001 From: Jordan Cook Date: Wed, 14 Jul 2021 12:31:57 -0500 Subject: [PATCH] Add Conda badge and update contributing guide with more post-release steps --- CONTRIBUTING.md | 16 ++++++++++++---- README.md | 1 + 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 524d6d2d..60395fda 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -80,13 +80,21 @@ Here are some general guidelines for submitting a pull request: - Submit the PR to be merged into the `main` branch. ### Releases -For maintainers: +Notes for maintainers on publishing new releases: Releases are based on git tags. GitHub Actions will build and deploy packages to PyPi on tagged commits on the `main` branch. Release steps: -- Update the version in `pyinaturalist/__init__.py` +- Update the version in both `pyproject.toml` and `pyinaturalist/__init__.py` - Update the release notes in `HISTORY.md` - Merge changes into the `main` branch -- Push a new tag, e.g.: `git tag v0.1 && git push origin --tags` +- Push a new tag, e.g.: `git tag v0.1.0 && git push upstream --tags` - This will trigger a deployment. Verify that this completes successfully and that the new version - can be installed from pypi with `pip install` + can be installed from PyPI with `pip install pyinaturalist`. +- Verify that the docs are built and published to [Read The Docs](https://pyinaturalist.readthedocs.io). +- A PR for a new Conda release will be created by a bot on the [pyinaturalist-feedstock](https://github.com/conda-forge/pyinaturalist-feedstock/) + repo. It may take a couple hours after PyPI deployment for this to happen. Typically this will be + auto-merged and built without any manual action required. Just verify that this completes successfully + and that the new version can be installed from conda-forge with `conda install -c conda-forge pyinaturalist`. + - If new depedencies have been added, then those must also be added to the [conda recipe](https://github.com/conda-forge/pyinaturalist-feedstock/blob/master/recipe/meta.yaml). +- Update and build the Docker image for [pyinaturalist-notebook](https://github.com/JWCook/pyinaturalist-notebook). + - TODO: This should be fully automated, and triggered after the Conda build rather than the PyPI build. \ No newline at end of file diff --git a/README.md b/README.md index f56c094a..ce6e4a67 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ [![Coverage Status](https://coveralls.io/repos/github/niconoe/pyinaturalist/badge.svg?branch=main)](https://coveralls.io/github/niconoe/pyinaturalist?branch=main) [![PyPI](https://img.shields.io/pypi/v/pyinaturalist?color=blue)](https://pypi.org/project/pyinaturalist) +[![Conda](https://img.shields.io/conda/vn/conda-forge/pyinaturalist?color=blue)](https://anaconda.org/conda-forge/pyinaturalist) [![PyPI - Python Versions](https://img.shields.io/pypi/pyversions/pyinaturalist)](https://pypi.org/project/pyinaturalist) [![PyPI - Format](https://img.shields.io/pypi/format/pyinaturalist?color=blue)](https://pypi.org/project/pyinaturalist)