Skip to content

Make poetry a prerequisite #307

@dgarcia360

Description

@dgarcia360

Motivation

If the user does not have it installed poetry, the toolchain installs the package manager automatically using the script located in docs/_utils/setup.sh.

It's a better practice to let the user install Poetry as a prerequisite in their machine for the following reasons:

  1. The user can decide which version of poetry they want to install. We are now forcing them to choose one version, which is usually not the latest.

  2. With the latest version, the installation instructions have changed. Therefore, we should update the script in every repo.

  3. We would get rid of the docs/_utils/setup.sh script, which is sometimes different between projects depending on when they installed the toolchain.

  4. docs/_utils/setup.sh makes the documentation toolchain only compatible with UNIX systems. However, this is not compatible with other OS such as Windows.

Proposal

  • Remove the file docs/_utils/setup.sh.
  • Adapt the Makefile to not call this file.
  • Adapt the GitHub Actions workflows to install poetry.
  • List poetry as a prerequisite in the installation guide.

Before we release the change

When we open issues for each repository to migrate to 1.1, we will link to a guide where we list:

  • How to remove the current poetry installation.
  • How to install the latest poetry.
  • Which files need to be removed or adapted.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions