diff --git a/.github/workflows/publish_pypi.yml b/.github/workflows/publish_pypi.yml deleted file mode 100644 index 342f289..0000000 --- a/.github/workflows/publish_pypi.yml +++ /dev/null @@ -1,23 +0,0 @@ -on: - release: - types: [published] - -jobs: - publish-to-pypi: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - name: Set up Python - uses: actions/setup-python@v4 - with: - python-version: '3.9' - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install build - - name: Build package - run: python -m build - - name: Publish Package - uses: pypa/gh-action-pypi-publish@v1.5.1 - with: - password: ${{ secrets.PYPI_API_TOKEN }} diff --git a/README.md b/README.md index b7960cd..5e388a3 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,7 @@ # dds_registration A Django App to manage DdS membership and event registration. -[![Pypi Version](https://img.shields.io/pypi/v/django-dds_registration.svg)](https://pypi.org/project/django-dds_registration/) -[![Python Versions](https://img.shields.io/pypi/pyversions/django-dds_registration.svg)](https://pypi.org/project/django-dds_registration/) -[![Run tests](https://github.com/gchazot/dds_registration/actions/workflows/run_tests.yml/badge.svg)](https://github.com/gchazot/dds_registration/actions/workflows/run_tests.yml) +[![Run tests](https://github.com/sentier-dev/dds_registration/actions/workflows/run_tests.yml/badge.svg)](https://github.com/sentier-dev/dds_registration/actions/workflows/run_tests.yml) ## User accounts @@ -100,37 +98,20 @@ sequenceDiagram ## Development -The `dev_server.sh` script is here to help setting up a development site. - ```shell script -./dev_server.sh run -``` -This will start a local dev server running with its own virtualenv. +pip install -e ".[testing]" # or ".[dev]" for linters and pre-commit -```shell script -./dev_server.sh test -``` -This will run all the tests currently available in the codebase and provided by Django. +pytest # run the test suite (tests/, with coverage) -```shell script -./dev_server.sh --help +DEBUG=True DEV=True python manage.py migrate +DEBUG=True DEV=True python manage.py runserver # local dev server (sqlite) ``` -For more options the script has to offer. -## Releasing - -#### Preparation -* Update `setup.cfg` with the new version number and commit -* Merge all desired changes to `master` -* Create a release in GitHub with a summary description, including creating a new tag v. +Frontend assets (SCSS/TS) are rebuilt with `npm install && npm run update-assets`. -#### Automatic release -[Github Actions](https://github.com/gchazot/dds_registration/actions) take care of everything. +## Releasing -#### Manual release process -A little more involved but it's Okay I guess -```shell script -rm -rf build/ dist/ django_dds_registration.egg-info/ -python setup.py sdist -twine upload dist/* -``` +1. Merge all desired changes to `main`. +2. Create a GitHub release with a summary description and a new tag like `1.4.4`. + Merging alone deploys nothing; the production server installs from the + latest release zipball.