Skip to content

Commit 7674ab6

Browse files
authored
fix(docs): Update docs for Python build step (#5530)
1 parent 6c34c02 commit 7674ab6

File tree

2 files changed

+14
-12
lines changed

2 files changed

+14
-12
lines changed

cmd/pythonBuild_generated.go

Lines changed: 7 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

resources/metadata/pythonBuild.yaml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,18 @@ metadata:
22
name: pythonBuild
33
description: Step builds a python project
44
longDescription: |
5-
Step build python project using the setup.py manifest and builds a wheel and tarball artifact . please note that currently python build only supports setup.py
5+
This step will build a python project.
6+
It will prioritize `pyproject.toml` file but can also be used with a `setup.py` manifest and builds a wheel and tarball artifact.
67
7-
### build with depedencies from a private repository
8-
if your build has dependencies from a private repository you can include the standard requirements.txt into the source code with `--extra-index-url` as the first line
8+
### Build with depedencies from a private repository
9+
10+
If your build has dependencies from a private repository you can include the standard `requirements.txt` into the source code with `--extra-index-url` as the first line
911
1012
```
1113
--extra-index-url https://${PIPER_VAULTCREDENTIAL_USERNAME}:${PIPER_VAULTCREDENTIAL_PASSWORD}@<privateRepoUrl>/simple
1214
```
13-
`PIPER_VAULTCREDENTIAL_USERNAME` and `PIPER_VAULTCREDENTIAL_PASSWORD` are the username and password for the private repository
14-
and are exposed are environment variables that must be present in the environment where the Piper step runs or alternatively can be created using :
15-
[vault general purpose credentials](../infrastructure/vault.md#using-vault-for-general-purpose-and-test-credentials)
15+
16+
The variables `PIPER_VAULTCREDENTIAL_USERNAME` and `PIPER_VAULTCREDENTIAL_PASSWORD` are the username and password environemtn variables for the private repository must be present in the environment where the Piper step runs or alternatively can be created using [vault general purpose credentials](../infrastructure/vault.md#using-vault-for-general-purpose-and-test-credentials).
1617
spec:
1718
inputs:
1819
params:

0 commit comments

Comments
 (0)