File: CONTRIBUTING.md

package info (click to toggle)
python-poetry-dynamic-versioning 1.9.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 460 kB
  • sloc: python: 1,528; makefile: 4
file content (37 lines) | stat: -rw-r--r-- 977 bytes parent folder | download
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
## Development
This project is managed using [Poetry](https://poetry.eustace.io).

* If you want to take advantage of the default VSCode integration,
  then first configure Poetry to make its virtual environment in the repository:
  ```
  poetry config virtualenvs.in-project true
  ```
* After cloning the repository, activate the tooling:
  ```
  pipx install invoke
  poetry install --extras plugin
  poetry run pre-commit install
  ```

Commands defined in `tasks.py`:

* Load the deprecated `poetry-dynamic-versioning-plugin` package and switch back:
  ```
  invoke pdvp
  invoke pdv
  ```
* Build the currently loaded package:
  ```
  invoke build
  ```
* Run tests for the currently loaded package:
  ```
  invoke test
  ```
  [Git Bash](https://git-scm.com) is recommended for Windows.

## Release
* Run `invoke prerelease`
* Verify the changes and `git add` them
* Run `invoke release`
* Create a release on GitHub for the new tag and attach the artifacts from `dist`