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: README.dev.md
+27-8Lines changed: 27 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -187,32 +187,39 @@ This command will update the version in the following files:
187
187
188
188
## Making a release
189
189
190
-
This section describes how to make a release in 2 parts:
190
+
This section describes how to make a release in 3 parts:
191
191
192
-
1. Create Github release
193
-
2. Publish to Pypi
192
+
1. Create Github release (which will trigger a Zenodo archive)
193
+
2. Publish python package to Pypi
194
+
3. Publish the docs to GitHub Pages
194
195
195
-
### (1/2) Create Github release
196
+
### (1/3) Create Github release
196
197
197
198
We use the Github action [Draft or publish Github release
198
199
](https://github.com/NPLinker/nplinker/actions/workflows/publish_gh_release.yml) to create a Github release.
199
200
200
-
Click the right corner `Run workflow` button, then fill in the current version number and new version number, and choose `publish` to publish Github release, then click the `Run workflow` button.
201
+
Go to the workflow page and click the right corner `Run workflow` button, then fill in the current version number and new version number, and choose `publish` to publish Github release, then click the `Run workflow` button.
201
202
202
203
The action will first update the version with the command `make update-version`. Then it will generate a release notes and update the `CHANGELOG.md` file with the notes. After that, the action will commit and push the changes. In the end, the action will create a Github release with the new version number and create a tag for the release.
203
204
204
205
After the action is finished successfully, you can go to the [release page](https://github.com/NPLinker/nplinker/releases) to check the release.
205
206
206
207
This repository uses the GitHub-Zenodo integration, the new Github release will trigger Zenodo into making a snapshot of the repository and sticking a DOI on it. Check the [Zenodo page](https://zenodo.org/records/14723594) to see the new snapshot.
207
208
208
-
### (2/2) Publish to Pypi
209
+
### (2/3) Publish Python Package to Pypi
209
210
210
-
You can publish the package to pypi with the following steps:
211
+
You can publish the Python package to pypi with the following steps:
211
212
212
213
```shell
213
214
# Go to your local nplinker repository
214
215
cd path-to-nplinker-repo
215
216
217
+
# Make sure you have the latest changes from the remote repository
218
+
git pull origin dev
219
+
220
+
# Install the development dependencies [Optional]
221
+
pip install -e ".[dev]"
222
+
216
223
# Clean the repository
217
224
make clean
218
225
@@ -223,4 +230,16 @@ make build
223
230
make release
224
231
```
225
232
226
-
After publishing to pypi, you can check the [pypi page](https://pypi.org/project/nplinker/#history) to see the new version.
233
+
Note: you need to have an account on pypi and the permission to publish this package to pypi. Please ask the project maintainers for access.
234
+
235
+
After publishing to pypi, you can check the [pypi page](https://pypi.org/project/nplinker/#history) to see the new version.
236
+
237
+
### (3/3) Publish the docs
238
+
After creating a new release, you can publish the docs for the new version with the following command:
239
+
240
+
```shell
241
+
# change 2.0.3 to the new version number
242
+
make deploy-docs version=2.0.3
243
+
```
244
+
245
+
this will deploy the docs for the new version and mark it as the latest version. You can check the [docs page](https://nplinker.github.io/nplinker/) to see the new version of the docs.
0 commit comments