Skip to content

Commit

Permalink
chore: update to poetry 2.0.1, update readme and docs
Browse files Browse the repository at this point in the history
Thomas Neidhart committed Jan 27, 2025

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 4fddd78 commit ad069b8
Showing 8 changed files with 9 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -13,7 +13,7 @@ permissions:

env:
LATEST_PY_VERSION: '3.12'
POETRY_VERSION: '2.0.0'
POETRY_VERSION: '2.0.1'

jobs:
test:
2 changes: 1 addition & 1 deletion .github/workflows/generate-sbom.yml
Original file line number Diff line number Diff line change
@@ -12,7 +12,7 @@ on:

env:
PYTHON_VERSION: '3.12'
POETRY_VERSION: '2.0.0'
POETRY_VERSION: '2.0.1'

permissions:
contents: read
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -12,7 +12,7 @@ env:
REGISTRY: 'ghcr.io'
IMAGE_NAME: ${{ github.repository }}
PYTHON_VERSION: '3.12'
POETRY_VERSION: '2.0.0'
POETRY_VERSION: '2.0.1'

permissions:
contents: read
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -11,7 +11,7 @@ ifndef PIPX
endif

ifndef POETRY
pipx install "poetry>=2.0.0"
pipx install "poetry>=2.0.1"
endif

poetry config virtualenvs.in-project true
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -47,8 +47,7 @@ The documentation is available at [otterdog.readthedocs.io](https://otterdog.rea

* python3.11+ (mandatory): e.g. install using `apt install python3` or use `pyenv install 3.12`
* git (mandatory): install using `apt install git`
* poetry (mandatory): install using `pipx install poetry`
* dynamic versioning plugin (mandatory): install using `pipx inject poetry "poetry-dynamic-versioning[plugin]"`
* poetry >=2 (mandatory): install using `pipx install poetry>=2.0.1`
* bitwarden cli tool (optional): install using `snap install bw`
* pass cli tool (optional): install using `apt install pass`

@@ -60,7 +59,7 @@ The documentation is available at [otterdog.readthedocs.io](https://otterdog.rea
$ make init
```

Running `make init` will also install `poetry` and the `dynamic versioning plugin` if it is not installed yet.
Running `make init` will also install `poetry` if it is not installed yet.

* Testing build

2 changes: 1 addition & 1 deletion docker/Dockerfile
Original file line number Diff line number Diff line change
@@ -23,7 +23,7 @@ WORKDIR /app
ENV PIP_DEFAULT_TIMEOUT=100 \
PIP_DISABLE_PIP_VERSION_CHECK=1 \
PIP_NO_CACHE_DIR=1 \
POETRY_VERSION=2.0.0 \
POETRY_VERSION=2.0.1 \
POETRY_HOME='/usr/local' \
POETRY_DYNAMIC_VERSIONING_BYPASS=$version

2 changes: 1 addition & 1 deletion docs/contributing.md
Original file line number Diff line number Diff line change
@@ -28,7 +28,7 @@ You'll need the following prerequisites:
- Any Python version **>= 3.11**
- **git**
- **make**
- [**poetry**](https://python-poetry.org/docs/#installation)
- [**poetry >= 2**](https://python-poetry.org/docs/#installation)

### Installation and setup

2 changes: 1 addition & 1 deletion docs/install.md
Original file line number Diff line number Diff line change
@@ -15,7 +15,7 @@ apt install python3 python3-pip
* [`poetry`](https://python-poetry.org/): Python package manager

```bash
pipx install poetry
pipx install poetry>=2.0.1
```

* [`git`](https://git-scm.com/): popular distributed version control system

0 comments on commit ad069b8

Please sign in to comment.