Skip to content

Commit

Permalink
Add publication instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
gbip committed Jan 20, 2025
1 parent d11307f commit 4446d3f
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 2 deletions.
37 changes: 35 additions & 2 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,48 @@
# Dev setup

## Publishing (test pypy)
## Publishing (test pypy)

First create an account on [test pypi]() and generate a token.

Then, run :
Clean your worktree and tag your release to generate a valid version number (otherwise pypi will reject your release) :

```
git stash # clean your worktree
git tag 0.0.18rc1
git stash pop # restore your worktree
```

Then, publish using the Makefile to build and push the library :

```
make clean && make build && make publish-test
```

## Publishing (production)

Make sure that you are on the maintainer list of the [pypi project](https://pypi.org/project/django-pyoidc/) and generate an API token for this project.

Clean your worktree and tag your release :

```
git stash # clean your worktree
git tag 0.0.1 # tag the release
git stash pop # tag your release
```

Build the python package :

```
make clean && make build
```

Publish it :

```
make publish
```


## Installation

```bash
Expand Down
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ requirements/requirements-test.txt : requirements/requirements-test.in requireme
publish-test:
hatch publish -r test -u __token__

publish:
hatch publish -r main -u __token__

build:
hatch build

Expand Down

0 comments on commit 4446d3f

Please sign in to comment.