Skip to content

Commit b42d066

Browse files
committed
Add documentation for release-pkg-devpi-python
1 parent 9fb13f7 commit b42d066

4 files changed

Lines changed: 54 additions & 9 deletions

File tree

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Build and Publish DEVPI (UV)
2+
3+
**Name:** ``Build and Publish DEVPI (UV)``
4+
5+
**Workflow File:** ``release-pkg-devpi-python``
6+
7+
**Description:**
8+
9+
This workflow builds a python package and uses uv to upload it to devpi (SIPE's internal python package repository).
10+
11+
**Created By:** Jessy Liao (SIPE)
12+
13+
## Parameters
14+
15+
**Inputs:**
16+
17+
- ``runner-label`` (optional): runner to use
18+
- default: to "eng-tools"
19+
20+
**Outputs:** N/A
21+
22+
## Examples
23+
24+
### Example 1: Publish on new tag
25+
26+
**workflow.yml**
27+
```yml
28+
name: Tag and Publish
29+
30+
on:
31+
push:
32+
branches:
33+
- main
34+
35+
jobs:
36+
publish:
37+
needs: tag
38+
uses: AllenNeuralDynamics/.github/.github/workflows/release-pkg-devpi-python.yml@main
39+
with:
40+
tag-name: ${{ github.ref }}
41+
```
42+
43+
**Results:**
44+
45+
- Automatically build python package and uploads it to devpi whenever changes are pushed to main

.github/docs/Build and Release EXE (UV and pyInstaller).md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ on:
5757
jobs:
5858
publish:
5959
needs: tag
60-
uses: AllenNeuralDynamics/.github/.github/workflows/release-exe-uv_pyinstaller-python.yml@dev
60+
uses: AllenNeuralDynamics/.github/.github/workflows/release-exe-uv_pyinstaller-python.yml@main
6161
with:
6262
tag-name: ${{ github.ref }}
6363
```
@@ -82,10 +82,10 @@ on:
8282

8383
jobs:
8484
tag:
85-
uses: AllenNeuralDynamics/.github/.github/workflows/release-tag-uv-python.yml@dev
85+
uses: AllenNeuralDynamics/.github/.github/workflows/release-tag-uv-python.yml@main
8686
publish:
8787
needs: tag
88-
uses: AllenNeuralDynamics/.github/.github/workflows/release-exe-uv_pyinstaller-python.yml@dev
88+
uses: AllenNeuralDynamics/.github/.github/workflows/release-exe-uv_pyinstaller-python.yml@main
8989
with:
9090
project-version: ${{ needs.auto-tag.outputs.version }}
9191
tag-name: v${{ needs.auto-tag.outputs.version }}

.github/docs/Tag Auto Bump (UV).md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ on:
4141

4242
jobs:
4343
tag:
44-
uses: AllenNeuralDynamics/.github/.github/workflows/release-tag-uv-python.yml@dev
44+
uses: AllenNeuralDynamics/.github/.github/workflows/release-tag-uv-python.yml@main
4545
```
4646
4747
**Results:**
@@ -84,10 +84,10 @@ on:
8484

8585
jobs:
8686
tag:
87-
uses: AllenNeuralDynamics/.github/.github/workflows/release-tag-uv-python.yml@dev
87+
uses: AllenNeuralDynamics/.github/.github/workflows/release-tag-uv-python.yml@main
8888
publish:
8989
needs: tag
90-
uses: AllenNeuralDynamics/.github/.github/workflows/release-exe-uv_pyinstaller-python.yml@dev
90+
uses: AllenNeuralDynamics/.github/.github/workflows/release-exe-uv_pyinstaller-python.yml@main
9191
with:
9292
project-version: ${{ needs.auto-tag.outputs.version }}
9393
tag-name: v${{ needs.auto-tag.outputs.version }}

.github/workflows/release-pkg-devpi-python.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
name: Build and publish to devpi
1+
name: Build and Publish DEVPI (UV)
22

33
on:
44
workflow_call:
55
inputs:
6-
runner_label:
6+
runner-label:
77
description: 'Runner to use'
88
type: string
99
default: 'eng-tools'
@@ -15,7 +15,7 @@ on:
1515

1616
jobs:
1717
publish:
18-
runs-on: ${{ inputs.runner_label }}
18+
runs-on: ${{ inputs.runner-label }}
1919
env:
2020
UV_PYTHON_INSTALL_DIR: C:\ProgramData\AIBS_MPE\uv_python
2121
UV_TOOL_DIR: C:\ProgramData\AIBS_MPE\uv_python

0 commit comments

Comments
 (0)