Skip to content

ci: adding infos on how to use publish workflow #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ The following workflows exists:
- doc.yml: built for running tox docs target
- unittest.yml: built for executing tox unittests target
- lint.yml: built for executing tox lint target
- publish.yml: publish and attest build and dev versions using jfrog

## reusable workflows usage

Expand All @@ -43,3 +44,35 @@ uses: outpost-os/pipeline-python/.github/workflows/lint.yml@v1
with:
python-version: '3.12'
```

## Jfrog publication

In order to publish to Jfrog, given that the calling repository is properly configured in terms of OICD with the Artifactory instance,
using the publication workflow would be using such a syntax:


```
name: Upload Python Package to jfrog

on:
push:
branches:
- main

jobs:
pubhlish:
permissions:
id-token: write
contents: read
attestations: write
uses: outpost-os/pipeline-python/.github/workflows/publish.yml@main
with:
environment: local_publication_env_name
runner: runner_tag
python-version: '3.10'
build-name: package-build-name
module-name: package-name # used by pip install
repo-name: publication-repo-name
virtual-repo-name: pip-install-repo-name
```