Skip to content

Commit b136f32

Browse files
authored
patch version and update readme with publishing instructions (#17)
1 parent a502ccf commit b136f32

File tree

2 files changed

+34
-1
lines changed

2 files changed

+34
-1
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,3 +118,36 @@ If you wish to create your own ECS formatter, you can inherit from ECSSystemForm
118118
Run `poetry run pytest` in the root directory to run all tests.
119119

120120
Or, run `poetry run tox` in the root directory to run all tests for multiple Python versions. See the [`tox` configuration file](tox.ini).
121+
122+
### Publishing
123+
124+
1. Acquire API token from [Passman](https://passman.ci.uktrade.digital/secret/cc82a3f7-ddfa-4312-ab56-1ff8528dadc8/).
125+
- Request access from the SRE team.
126+
- _Note: You will need access to the `platform` group in Passman._
127+
2. Run `poetry config pypi-token.pypi <token>` to add the token to your Poetry configuration.
128+
129+
Update the version, as the same version cannot be published to PyPI.
130+
131+
```
132+
poetry version patch
133+
```
134+
135+
More options for the `version` command can be found in the [Poetry documentation](https://python-poetry.org/docs/cli/#version). For example, for a minor version bump: `poetry version minor`.
136+
137+
Build the Python package.
138+
139+
```
140+
poetry build
141+
```
142+
143+
Publish the Python package.
144+
145+
_Note: Make sure your Pull Request (PR) is approved and contains the version upgrade in `pyproject.toml` before publishing the package._
146+
147+
```
148+
poetry publish
149+
```
150+
151+
Check the [PyPI Release history](https://pypi.org/project/django-log-formatter-ecs/#history) to make sure the package has been updated.
152+
153+
For an optional manual check, install the package locally and test everything works as expected.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ line-length = 100
33

44
[tool.poetry]
55
name = "django-log-formatter-ecs"
6-
version = "0.0.5"
6+
version = "0.0.6"
77
description = "Formats Django logs in ECS format."
88
authors = ["Department for Business and Trade Platform Team <[email protected]>"]
99
license = "MIT"

0 commit comments

Comments
 (0)