Skip to content
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.

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

Documentation and naming fixes #74

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
name: Release
on:
push:
tags:
- "[0-9]+.[0-9]+.[0-9]+"
jobs:
test:
name: py${{ matrix.python-version }} @ ${{ matrix.os }}
strategy:
fail-fast: true
matrix:
Expand Down Expand Up @@ -47,6 +49,7 @@ jobs:
job-summary: true

release:
name: Release
runs-on: ubuntu-latest
needs: test
steps:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/todo-to-issue.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: "Run TODO to Issue"
name: "TODO to Issue"
on:
push:
branches: [ main ]
jobs:
build:
todo_to_issue:
runs-on: "ubuntu-latest"
steps:
- uses: "actions/checkout@v3"
Expand Down
40 changes: 40 additions & 0 deletions how_to_release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Note for me

## Requirements

```bash
pip install bumpver build twine
```

## Steps

How to increase the version number:

```bash
git checkout main
git pull
bumpver update --patch # or --minor or --major
git push
git push --tags
```

This triggers the CI to build and release the package.

## ALL BELOW IS PERFORMED AUTOMATICALLY

> **_ATTENTION:_**
The following steps are performed automatically

(by the [CI release job](.github/workflows/release.yml))

If you want to release manually:

```bash
python -m build
twine check dist/*
twine upload dist/* # user: ct2034_0
```

## source

<https://realpython.com/pypi-publish-python-package/#build-your-package>
35 changes: 0 additions & 35 deletions how_to_update.md

This file was deleted.