Skip to content
Snippets Groups Projects
Commit 33c28bbf authored by mjbonifa's avatar mjbonifa
Browse files

docs: added release commands to contributing.md

parent 1ea2ef39
Branches
No related tags found
No related merge requests found
...@@ -67,6 +67,13 @@ To run tests using `pytest`, use: ...@@ -67,6 +67,13 @@ To run tests using `pytest`, use:
hatch run pytest hatch run pytest
``` ```
## Running the CLI
The package provides a command-line interface (CLI) entry point.
```sh
acmc --help
```
### All code checks ### All code checks
The project run all type and formatting checking The project run all type and formatting checking
...@@ -103,13 +110,30 @@ To build the package, use: ...@@ -103,13 +110,30 @@ To build the package, use:
hatch build hatch build
``` ```
## Running the CLI ## Releasing the Package
The package provides a command-line interface (CLI) entry point.
Update the version number in pyproject.toml
Build the package using:
```sh ```sh
acmc --help hatch build
``` ```
Creates file `acmc-<version>-py3-none-any.whl` in the `./dist` directory
Check package using:
```sh
twine check dist/acmc-<version>-py3-none-any.whl
```
Upload to pypi using:
```sh
twine upload dist/acmc-<version>-py3-none-any.whl --username __token__ --password <your pypi token>
```
## Contributing ## Contributing
### GitLab Basic Workflow Overview ### GitLab Basic Workflow Overview
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment