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: CONTRIBUTING.md
+22Lines changed: 22 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -88,6 +88,28 @@ poetry run sphinx-build docs docs/_build --builder html --fail-on-warning
88
88
start docs\_build\index.html
89
89
```
90
90
91
+
# Publishing on PyPI
92
+
93
+
You can publish the `nitypes` package by creating a GitHub release
94
+
in the `nitypes-python` repo. Here are the steps to follow to publish the package:
95
+
96
+
1. From the main GitHub repo page, select "Create a new release".
97
+
2. On the "New Release" page, create a new tag using the "Select Tag" drop down. The tag must be the package version, matching the
98
+
value found in pyproject.toml. Example: `0.1.0-dev0`.
99
+
3. Enter a title in the "Release title" field. The title should contain the package name and
100
+
version in the format `nitypes <package-version>`. For example: `nitypes 0.1.0-dev0`.
101
+
4. Click "Generate release notes" and edit the release notes.
102
+
- Delete entries for PRs that do not affect users, such as "chore(deps):" and "fix(deps):" PRs.
103
+
- Consider grouping related entries.
104
+
- Reformat entries to be more readable. For example, change "Blah blah by so-and-so in \#123" to "Blah blah (\#123)".
105
+
5. If this is a pre-release release, check the "Set as a pre-release" checkbox.
106
+
6. Click "Publish release".
107
+
7. Creating a release will start the publish workflow. You can track the
108
+
progress of this workflow in the "Actions" page of the GitHub repo.
109
+
8. The workflow job that publishes a package to PyPI requires code owner approval. This job will automatically send code owners a notification email, then it will wait for them to log in and approve the deployment.
110
+
9. After receiving code owner approval, the publish workflow will resume.
111
+
10. Once the publish workflow has finished, you should see your release on PyPI.
0 commit comments