Skip to content

Commit

Permalink
update readme and add a build stage
Browse files Browse the repository at this point in the history
  • Loading branch information
tab-cmd committed Nov 26, 2024
1 parent 355bd33 commit bbab8e9
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 7 deletions.
6 changes: 6 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,9 @@ jobs:
- name: lint
run: |
make lint
- name: build
run: |
make build
build-macos:

Expand Down Expand Up @@ -125,3 +128,6 @@ jobs:
- name: lint
run: |
make lint
- name: build
run: |
make build
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ dev-install:
pip install -e ".[dev]"
make install

make-build:
pip install -e ".[release]"
python -m build --sdist --wheel

test-all:
make coverage-report
make type
Expand Down
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -356,23 +356,28 @@ make type
## Release
----------

The process to release a new version of BciPy is as follows:
The process to release a new version of BciPy is done through the below steps. An admin PyPi account is required to upload the package with a valid token. An admin GitHub account is also required to create tag the release. Reach out to the development team for more information.

### Install release dependencies and create a universal wheel

Configuration for the distribution is in `pyproject.toml`. To create a universal wheel, run:

### Install release dependencies

```sh
pip install -e ".[release]"
python -m build --sdist --wheel
```

### Create a universal wheel
Alternately, if Make is installed, you may run the follow command to build the wheel:

Configuration for the distribution is in `pyproject.toml`. To create a universal wheel, run:
```sh
python -m build --sdist --wheel
make build
```

### Upload to PyPi

To upload the package to [PyPi](https://pypi.org/project/bcipy/), run:

```sh
twine upload dist/*
```
Expand All @@ -384,9 +389,9 @@ git tag v*add_version*
git push --tags'
```
### Create a release on GitHub
### Create GitHub Release
Using the tag you just created, create a release on GitHub. Include the release notes from the CHANGELOG in the description.
Using the tag you just created, create a release on GitHub. Include the release notes from the CHANGELOG in the description. See https://github.com/CAMBI-tech/BciPy/releases for examples.
### Contributions Welcome!
--------------------------
Expand Down

0 comments on commit bbab8e9

Please sign in to comment.