File: release.md

package info (click to toggle)
ngspetsc 0.1.1-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 27,120 kB
  • sloc: python: 3,391; makefile: 42; sh: 29
file content (54 lines) | stat: -rw-r--r-- 1,162 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# Poetry notes for Umberto

## Poetry
Remember that poetry cannot be installed in the same environment as the project.
Create a virtual environment somewhere permanent and you can use a bash alias to drive poetry:

```bash
python -m venv ~/.poetry
source ~/.poetry/bin/activate
pip install poetry

# check location of executable with
which poetry

# create alias (could be added to ~/.bash_profile)
alias poetry="$HOME/.poetry/bin/poetry"
```

When carrying out any of the below tasks create a new empty virtual environment!
```bash
python -m venv temp
source temp/bin/activate
```

## Add a dependency
[Docs](https://python-poetry.org/docs/cli/#add)
```bash
poetry add numpy@^2
```

## Build ngsPETSc
[Docs](https://python-poetry.org/docs/cli/#build)
```bash
poetry build
```

## Create a release
Follow these steps to create a release:
```bash
# For a bug fix:
poetry version patch
# OR for a minor version bump:
poetry version minor
# OR for a major release:
poetry version minor

git add pyproject.toml
git commit -m "Release v$(poetry version)"

git tag -a -m "Release v$(poetry version)" v$(poetry version)

git push
git push origin v$(poetry version)
```