Skip to content

Commit 96480e2

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

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -211,13 +211,17 @@ When a new version of allms is ready to be released, do the following operations
211211
2. `git push origin <NEW-VERSION>`
212212

213213
3. **Publish package to PyPI**:
214-
1. Go to _Actions__Manual Publish To PyPI_;
215-
2. Select "master" as branch and click _Run workflow_;
214+
1. Go to _Actions__Release_;
215+
2. Select _tags_`<NEW_VERSION>` and click _Run workflow_;
216216
3. If successful, you will find the package under # TODO: open-source.
217217

218218
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`.
219+
1. Build package locally with command:
220+
```bash
221+
make build-package
222+
```
223+
This will create two files in the `dist` directory: `allms-<NEW-VERSION>.whl` and `allms-<NEW-VERSION>.tar.gz`;
224+
2. Go to _Releases_ → _Draft a new release_;
225+
3. Select the recently created tag in _Choose a tag_ window;
226+
4. Upload `allms-<NEW-VERSION>.whl` and `allms-<NEW-VERSION>.tar.gz` as assets;
227+
5. Click `Publish release`.

0 commit comments

Comments
 (0)