Skip to content

Remove broken PyPI publish workflow and stale README badges #168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lbougan merged 2 commits into from
Oct 14, 2026
Merged

Remove broken PyPI publish workflow and stale README badges #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e1014f
ci: remove broken PyPI publish workflow
lbougan Aug 24, 2026
8a4f09d
docs: replace stale dev_server.sh and PyPI release instructions in RE…
lbougan Aug 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 0 additions & 23 deletions .github/workflows/publish_pypi.yml
View file
Open in desktop

This file was deleted.

41 changes: 11 additions & 30 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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<version_number>.
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.
Loading