Add instructions for using tokens in CI with poetry

[greschd]

When depending on a private repository with poetry, it is not straightforward how to include this in CI:

In the pyproject.toml, the dependency is specified as

package_name = { git = "https://github.com/organization/repository",  branch = "branch_name" }

This works for local installs where the user is authenticated to GitHub, but on CI poetry doesn't recognize / use the token. As a workaround, we can use

git config --global url."https://${{ secrets.TOKEN_NAME }}@github.com/organization/repository".insteadOf "https://github.com/organization/repository"

to let git prepend the token whenever the given URL is encountered. In this way, token authentication can be used without having to hard-code (and, depending on current or future repo visibility, leak the token) in pyproject.tml.

This workaround should be documented, but it's not obvious where to do so; it's a bit too niche to belong in the general packaging guide IMO.

[pyansys-automation]

Hello @MaxJPRey, @clatapie, @Revathyvenugopal162, @RobPasMue, @germa89, @jorgepiloto!
This issue has been open for over a year and has had no updates in the past 8 months. If it is still relevant, please provide an update. Otherwise, consider closing it to help keep the issue tracker clean.

If this issue needs to remain open, please comment below with @pyansys-automation never close issue to prevent it from being automatically closed.

If you want this repository to be excluded from this automated maintenance process, please let us know by filling in the opt-out request form.

[RobPasMue]

@pyansys-automation never close issue

[pyansys-automation]

Thank you for your comment!
You unsubscribed this issue from automatic closing.