remove release to PiPy
Some checks failed
CI / linter (ubuntu-latest, 3.9) (push) Failing after 21s
Rename the project from template / rename-project (push) Has been skipped
CI / tests_linux (ubuntu-latest, 3.9) (push) Has been skipped

This commit is contained in:
Simon Diesenreiter 2024-11-10 07:37:02 -08:00
parent 5efd61d236
commit 0426e0c42c
4 changed files with 24 additions and 37 deletions

View File

@ -26,23 +26,23 @@ jobs:
with: with:
body_path: release_message.md body_path: release_message.md
deploy: # deploy:
needs: release # needs: release
runs-on: ubuntu-latest # runs-on: ubuntu-latest
steps: # steps:
- uses: actions/checkout@v1 # - uses: actions/checkout@v1
- name: Set up Python # - name: Set up Python
uses: actions/setup-python@v1 # uses: actions/setup-python@v1
with: # with:
python-version: '3.x' # python-version: '3.x'
- name: Install dependencies # - name: Install dependencies
run: | # run: |
python -m pip install --upgrade pip # python -m pip install --upgrade pip
pip install setuptools wheel twine # pip install setuptools wheel twine
- name: Build and publish # - name: Build and publish
env: # env:
TWINE_USERNAME: __token__ # TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }} # TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
run: | # run: |
python setup.py sdist bdist_wheel # python setup.py sdist bdist_wheel
twine upload dist/* # twine upload dist/*

View File

@ -112,7 +112,7 @@ with module imports or anything else, it is useful for CI, logs and debugging.
### Why to include `tests`, `history` and `Containerfile` as part of the release? ### Why to include `tests`, `history` and `Containerfile` as part of the release?
The `MANIFEST.in` file is used to include the files in the release, once the The `MANIFEST.in` file is used to include the files in the release, once the
project is released to PyPI all the files listed on MANIFEST.in will be included project is released to artifactory all the files listed on MANIFEST.in will be included
even if the files are static or not related to Python. even if the files are static or not related to Python.
Some build systems such as RPM, DEB, AUR for some Linux distributions, and also Some build systems such as RPM, DEB, AUR for some Linux distributions, and also

View File

@ -95,10 +95,7 @@ init: ## Initialize the project based on an application template.
This project uses [semantic versioning](https://semver.org/) and tags releases with `X.Y.Z` This project uses [semantic versioning](https://semver.org/) and tags releases with `X.Y.Z`
Every time a new tag is created and pushed to the remote repo, gitea actions will Every time a new tag is created and pushed to the remote repo, gitea actions will
automatically create a new release on gitea and trigger a release on PyPI. automatically create a new release on gitea.
For this to work you need to setup a secret called `PIPY_API_TOKEN` on the project settings>secrets,
this token can be generated on [pypi.org](https://pypi.org/account/).
To trigger a new release all you need to do is. To trigger a new release all you need to do is.

View File

@ -10,10 +10,8 @@ See also
1. Create a new repository from this template and choose a name for your project 1. Create a new repository from this template and choose a name for your project
(e.g. `my_awesome_project` - recommendation is to use all lowercase and underscores separation for repo names.) (e.g. `my_awesome_project` - recommendation is to use all lowercase and underscores separation for repo names.)
2. Wait until the first run of CI finishes (Gitea Actions will process the template and commit to your new repo) 2. Wait until the first run of CI finishes (Gitea Actions will process the template and commit to your new repo)
3. If you want Automatic Release to [PyPI](https://pypi.org) 3. Read the file [CONTRIBUTING.md](CONTRIBUTING.md)
On the new repository `settings->secrets` add your `PYPI_API_TOKEN` (get the tokens on PyPI website) 4. Then clone your new project and happy coding!
4. Read the file [CONTRIBUTING.md](CONTRIBUTING.md)
5. Then clone your new project and happy coding!
> **NOTE**: **WAIT** until first CI run on gitea actions before cloning your new project. > **NOTE**: **WAIT** until first CI run on gitea actions before cloning your new project.
@ -29,8 +27,6 @@ See also
`Containerfile` is a more open standard for building container images than Dockerfile, you can use buildah or docker with this file. `Containerfile` is a more open standard for building container images than Dockerfile, you can use buildah or docker with this file.
- 🧪 Testing structure using [pytest](https://docs.pytest.org/en/latest/) - 🧪 Testing structure using [pytest](https://docs.pytest.org/en/latest/)
- ✅ Code linting using [flake8](https://flake8.pycqa.org/en/latest/) - ✅ Code linting using [flake8](https://flake8.pycqa.org/en/latest/)
- 📊 Code coverage reports using [codecov](https://about.codecov.io/sign-up/)
- 🛳️ Automatic release to [PyPI](https://pypi.org) using [twine](https://twine.readthedocs.io/en/latest/) and gitea actions.
- 🎯 Entry points to execute your program using `python -m <project_name>` or `$ project_name` with basic CLI argument parsing. - 🎯 Entry points to execute your program using `python -m <project_name>` or `$ project_name` with basic CLI argument parsing.
- 🔄 Continuous integration using [Gitea Actions](.gitea/workflows/) with jobs to lint, test and release your project on Linux, Mac and Windows environments. - 🔄 Continuous integration using [Gitea Actions](.gitea/workflows/) with jobs to lint, test and release your project on Linux, Mac and Windows environments.
@ -53,12 +49,6 @@ cd project_name
make install make install
``` ```
From pypi:
```bash
pip install project_name
```
## Executing ## Executing
This application has a CLI interface that extends the Flask CLI. This application has a CLI interface that extends the Flask CLI.