You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/workflows/publish-to-pypi.yml
+14-20Lines changed: 14 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ name: release
4
4
5
5
# Usage:
6
6
# - Create a new tag with the version number in the format v*.*.* where * are integers: `git tag v1.2.3`
7
-
# - Push the tag to the repository: `git push --tags`
7
+
# - Push the tag to the repository: `git push origin tag v1.2.3`
8
8
9
9
# Result:
10
10
# - Check if the new version is greater than the latest version on PyPI
@@ -16,33 +16,25 @@ name: release
16
16
# Checklist for using this workflow up for a new project:
17
17
18
18
# 1. In github settings:
19
-
# - Create an environment called `release` (GH_ENV_NAME) and setup the permissions (https://github.com/<ORGANIZATION>/<REPO_NAME>/settings/environments)
19
+
# - Create an environment called `release`
20
+
# - Setup the permissions (https://github.com/<ORGANIZATION>/<REPO_NAME>/settings/environments)
21
+
# - Add the following variables:
22
+
# - PACKAGE_NAME: the name of your package on pypi
23
+
# - PYTHON_VERSION: the version of Python you want to use
20
24
21
25
# 2. On PyPi:
22
26
# - Create the project and add a trusted publisher (https://pypi.org/manage/project/<PACKAGE_NAME>/settings/publishing/ or https://pypi.org/manage/account/publishing if the project is not on pypi yet)
23
27
# - Ensure the publisher is configured to use:
24
-
# - environment name: `release` (can be changed, but should be the one created in the github settings)
25
28
# - the filename of this workflow yml (in this case: publish-to-pypi.yml)
26
29
27
-
# 3. In this file:
28
-
# - In the `env` section (~L45):
29
-
# - Update the name of your package (PACKAGE_NAME)
30
-
# - Update the version of Python you want to use (PYTHON_VERSION)
31
-
# - Update the name name of the environment you created in github settings (GH_ENV_NAME)
32
-
33
30
# - In the `setup_and_build` job:
34
31
# - Update the the shell commands to install your package
0 commit comments