Skip to content

Commit 67e893f

Browse files
committed
Fix readme, cleanup
1 parent c4a4ae9 commit 67e893f

File tree

6 files changed

+24
-99
lines changed

6 files changed

+24
-99
lines changed

.travis.yml

Lines changed: 0 additions & 51 deletions
This file was deleted.

Dockerfile

Lines changed: 0 additions & 10 deletions
This file was deleted.

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -52,18 +52,21 @@ documentation of all classes check the API Documentation below.
5252
## API Documentation
5353
[https://firedynamics.github.io/fdsreader/](https://firedynamics.github.io/fdsreader/)
5454

55-
## Deployment
56-
As the fdsreader has come a long way and the free capabilities of Travis CI have been used up, we now moved to manual CI/CD using a local docker container.
57-
First, the Dockerfile has to be modified to make authentication to GitHub and PyPI possible from within the container.
58-
To do so generate these two tokens:
59-
PyPI: https://pypi.org/manage/account/token/
60-
GitHub: https://github.com/settings/tokens/new (set the repo_deployment and public_repo scopes)
61-
Now add these Tokens in the Dockerfile. To now deploy the fdsreader to PyPI and update the Github Pages (Documentation), run the following commands after pushing your changes to the FDSReader to GitHub (apart from the Dockerfile).
62-
```bash
63-
cd $REPO_ROOT_DIR
64-
docker build . -t fdsreader-ci # Only needed the very first time
65-
docker run --rm fdsreader-ci
66-
```
55+
Deployment now follows the [Python Packaging User Guide's recommendation](https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/).
56+
57+
With this setup, deployments to both TestPyPI and PyPI are automated. Every push to GitHub triggers a deployment to TestPyPI, simplifying the testing of new changes and validating the CI pipeline. Therefore, it is necessary to set the package version to `.dev` to avoid blocking version numbers.
58+
59+
### Deploying an Untested/Unstable Version:
60+
1. Execute: `python3 -m incremental.update fdsreader --dev`
61+
2. Push changes to GitHub.
62+
63+
If you are sure your changes are stable push a GitHub Tag to perform deployment
64+
to PyPI and to pack a GitHub Release
65+
Deploying a tested/stable version:
66+
1. set the new version with `python3 -m incremental.update fdsreader --newversion=<version>`
67+
2. Push changes to GitHub
68+
3. Push Tag to GitHub with git push origin tag <version>
69+
6770

6871
### Manual deployment
6972
It is also possible to deploy to PyPI and Github pages manually using the following steps:

docker_deployment.sh

Lines changed: 0 additions & 23 deletions
This file was deleted.

fdsreader/_version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@
77

88
from incremental import Version
99

10-
__version__ = Version("fdsreader", 1, 10, 3)
10+
__version__ = Version("fdsreader", 1, 11, 6)
1111
__all__ = ["__version__"]

pyproject.toml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
[build-system]
2-
requires = ["setuptools>=42", "wheel"]
2+
requires = [
3+
"setuptools",
4+
"wheel",
5+
"incremental>=24.7.2", # ← Add incremental as a build dependency
6+
]
37
build-backend = "setuptools.build_meta"
48

59
[project]
610
name = "fdsreader"
7-
version = "1.11.6.dev1"
11+
dynamic = ["version"]
812
description = "Python reader for data generated by FDS."
913
readme = "README.md"
1014
requires-python = ">=3.6"
@@ -31,6 +35,8 @@ dev = [
3135
"pytest >=6.0"
3236
]
3337

38+
[tool.incremental]
39+
3440
[tool.setuptools]
3541
packages = ["fdsreader","fdsreader.bndf","fdsreader.devc","fdsreader.evac","fdsreader.export","fdsreader.fds_classes","fdsreader.geom","fdsreader.isof","fdsreader.part","fdsreader.pl3d","fdsreader.slcf","fdsreader.smoke3d","fdsreader.utils"]
3642

0 commit comments

Comments
 (0)