Skip to content

Commit d6358ef

Browse files
committed
docs: update the contributing doc
1 parent a88af74 commit d6358ef

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,4 +122,23 @@ before committing.
122122

123123
The deployment should be automated and can be triggered from the Semantic Release workflow in GitHub. The next version will be based on [the commit logs](https://python-semantic-release.readthedocs.io/en/latest/commit-log-parsing.html#commit-log-parsing). This is done by [python-semantic-release](https://python-semantic-release.readthedocs.io/en/latest/index.html) via a GitHub action.
124124

125+
Alternatively, the release can be built and distributed manually by poetry, by following
126+
the following steps
127+
128+
1. Create a new environment and install poetry
129+
130+
```
131+
virtualenv .env && .env/bin/pip install poetry
132+
```
133+
134+
2. Update the version in both the setup file `pyproject.toml` and package
135+
file `src/fpm_universe/__init__.py`
136+
137+
3. Build the distributions and then publish
138+
139+
```
140+
rm -rf dist
141+
.env/bin/poetry build && .env/bin/poetry publish
142+
```
143+
125144
[gh-issues]: https://github.com/factorpricingmodel/factor-pricing-model-universe/issues

0 commit comments

Comments
 (0)