Skip to content

Commit c989588

Browse files
committed
update release instruction in README
1 parent ba92852 commit c989588

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -204,20 +204,20 @@ via the github action `.github/workflows/docs.yml`
204204
When a new version of allms is ready to be released, do the following operations:
205205

206206
1. **Merge to master** the dev branch in which the new version has been specified:
207-
1. In this branch, `version` under `[tool.poetry]` section in `pyproject.toml` should be updated, e.g `0.1.0`;
208-
209-
2. **Tag the new master** with the name of the newest version using command-line:
210-
1. `git tag -a <NEW-VERSION>`
211-
2. `git push origin <NEW-VERSION>`
207+
1. In this branch, `version` under `[tool.poetry]` section in `pyproject.toml` should be updated with `<NEW-VERSION>`, e.g `0.1.0`.
208+
209+
2. **Make a GitHub release**:
210+
1. Build package locally with command:
211+
```bash
212+
make build-package
213+
```
214+
This will create two files in the `dist` directory: `allms-<NEW-VERSION>.whl` and `allms-<NEW-VERSION>.tar.gz`;
215+
2. Go to _Releases_ → _Draft a new release_;
216+
3. In _Choose a tag_ window, choose `Create a new tag` and set the tag name to `<NEW_VERSION>`;
217+
4. Upload `allms-<NEW-VERSION>.whl` and `allms-<NEW-VERSION>.tar.gz` as assets;
218+
5. Click `Publish release`.
212219

213220
3. **Publish package to PyPI**:
214-
1. Go to _Actions__Manual Publish To PyPI_;
215-
2. Select "master" as branch and click _Run workflow_;
216-
3. If successful, you will find the package under # TODO: open-source.
217-
218-
4. **Make a GitHub release**:
219-
1. Go to _Releases__Draft a new release_;
220-
2. Select the recently created tag in _Choose a tag_ window;
221-
3. Copy/paste all the content present in the CHANGELOG under the version you are about to release;
222-
4. Upload `allms-<NEW-VERSION>.whl` and `allms-<NEW-VERSION>.tar.gz` as assets;
223-
5. Click `Publish release`.
221+
1. Go to _Actions_ → _Release_;
222+
2. Select _tags_ → `<NEW_VERSION>` and click _Run workflow_;
223+
3. If successful, you will find the package under: https://pypi.org/project/allms/

0 commit comments

Comments
 (0)