From d7b7135bfdbd44911b7cd3b4e08e5b185d2361e7 Mon Sep 17 00:00:00 2001 From: Kevin Anchukaitis Date: Fri, 1 Mar 2024 13:55:23 -0700 Subject: [PATCH] Update release-instructions.md to note the number of changes made in pypi_release.yml --- release-instructions.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/release-instructions.md b/release-instructions.md index 4fa4b46..fa6ff9a 100644 --- a/release-instructions.md +++ b/release-instructions.md @@ -7,6 +7,6 @@ In the main branch of the dplpy github repository, update the following files in - In the `__init__.py` file in the `dplpy` folder, update `__version__` to the new version number. - In the `pyproject.toml` file, update the version number in the `[project]` section to match the new version number set in `__init__.py`. -- In the `.github/workflows` folder, find `pypi_release.yml` and update the branch name for the workflow to run in to v + the new version number(i.e., v0.1.1 if the version number is 0.1.1). +- In the `.github/workflows` folder, find `pypi_release.yml`, where you'll make **4 total changes**. First, update the branch name for the workflow to run in to v + the new version number (i.e., v0.1.1 if the version number is 0.1.1). - Still in `pypi_release.yml`, ensure that the first step of the workflow uses code from the branch name you just set the workflow to run in (which should be named v + the version number). -- Still in `pypi_release.yml`, update the name of the tag being created in the create release step to v + the new version number, and change the release name to the new version number. Finally, update the description of the git release using the `body` field located under the tag name and release name. You can also set the release as a draft or prerelease using the remaining fields. \ No newline at end of file +- Still in `pypi_release.yml`, update the name of the tag being created in the create release step to v + the new version number, and change the release name to the new version number. Finally, update the description of the git release using the `body` field located under the tag name and release name. You can also set the release as a draft or prerelease using the remaining fields.