Skip to content

Commit a999a83

Browse files
committed
Documentation: Describe how to release new version
1 parent 6332744 commit a999a83

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,3 +195,43 @@ With the single subpacket being:
195195
| `00 24` | `00 01` | `00 01 00 A8` | `00 00 01 F6` (Var. 502) `00` (12x Filling Bytes) `00 00 00 08` (#Bytes coming after this) `40 59 00 00 00 00 00 00` (Value as double) |
196196

197197
This writes 100.0 to #502.
198+
199+
## Development
200+
201+
### Release
202+
203+
In the steps below we assume that you
204+
205+
- installed [`uv`](https://docs.astral.sh/uv/), and
206+
- execute commands in the root of the repository.
207+
208+
Please replace `<VERSION>` with the version number of the package that you want to release (e.g. `0.2.0`).
209+
210+
#### PyPI
211+
212+
To release a new version on [PyPI](https://pypi.org/project/icostate/) please use the commands below:
213+
214+
```sh
215+
uv version <VERSION>
216+
export pyfocas_version="$(uv version --short)"
217+
git commit -a -m "Release: Release version $pyfocas_version"
218+
git tag "$pyfocas_version"
219+
git push && git push --tags
220+
```
221+
222+
#### GitHub
223+
224+
Open the [release notes](https://github.com/MyTooliT/pyfocas/doc/release) for the latest version and [create a new release](https://github.com/MyTooliT/pyfocas/releases/new):
225+
226+
1. Paste the release notes into the main text of the release web page
227+
2. Insert the version number into the tag field
228+
3. For the release title use “Version <VERSION>”, where `<VERSION>` specifies the version number (e.g. “Version 0.2”)
229+
4. Click on “Publish Release”
230+
231+
**Note:** Alternatively you can also use the [`gh`](https://cli.github.com) command:
232+
233+
```sh
234+
gh release create
235+
```
236+
237+
to create the release.

doc/release/0.1.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# General
2+
3+
Initial Release

0 commit comments

Comments
 (0)