Skip to content

Commit

Permalink
Update release-instructions.md to note the number of changes made in …
Browse files Browse the repository at this point in the history
…pypi_release.yml
  • Loading branch information
kanchukaitis committed Mar 1, 2024
1 parent b47b434 commit d7b7135
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions release-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
- 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.

0 comments on commit d7b7135

Please sign in to comment.