Skip to content

Commit 3b8fbf9

Browse files
arrowplumarrowplum
committed
chore(workflows): update README files to reflect changes in build ID and artifact naming conventions
1 parent af8902b commit 3b8fbf9

File tree

2 files changed

+20
-9
lines changed

2 files changed

+20
-9
lines changed

‎.github/workflows/deploy-artifacts/README.md‎

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,25 @@ The workflow processes artifacts from a `build-artifacts` directory and creates
1717
| Input | Description | Required | Default |
1818
| -------------------------------- | ---------------------------------------------------------- | -------- | ------------------------------- |
1919
| `project` | JFrog Artifactory project name | Yes | - |
20-
| `build-name` | Name for the unified build | Yes | - |
20+
| `build-name` | JFrog build name | Yes | - |
21+
| `build-id` | JFrog build ID for the overall build info | Yes | - |
22+
| `metadata-build-id` | JFrog build ID for the build metadata | Yes | - |
2123
| `version` | Version string for build info | Yes | - |
2224
| `artifactory-url` | JFrog Artifactory URL | No | `https://artifact.aerospike.io` |
2325
| `artifactory-oidc-provider-name` | OIDC provider name for authentication | No | `gh-citrusleaf` |
2426
| `artifactory-oidc-audience` | OIDC audience for authentication | No | `citrusleaf` |
25-
| `artifact-name` | Name of the artifacts to download | No | `build-artifacts` |
27+
| `artifact-name` | Name of the artifacts to download | No | `signed-artifacts` |
2628
| `retention-days` | Retention days for the artifacts | No | `1` |
2729
| `runs-on` | The runner to use for the build | No | `ubuntu-22.04` |
2830
| `checkout-path` | Directory to checkout the shared-workflows repository into | No | `shared-workflows` |
2931
| `dry-run` | Whether to run in dry-run mode | No | `false` |
3032

33+
## Outputs
34+
35+
| Output | Description |
36+
| ---------- | ----------------- |
37+
| `build-id` | The build ID used |
38+
3139
## Structure
3240

3341
### Debian/Ubuntu
@@ -79,13 +87,15 @@ jobs:
7987
upload:
8088
uses: aerospike/shared-workflows/.github/workflows/reusable_deploy-artifacts.yaml@CURRENTGITSHA # vn.n.n
8189
with:
82-
project: database
83-
build-name: database
84-
version: ${{ github.ref_name }}
90+
project: database
91+
build-name: database
92+
build-id: 1234567890
93+
metadata-build-id: 1234567890-metadata
94+
version: ${{ github.ref_name }}
8595
artifactory-url: https://artifact.aerospike.io
8696
artifactory-oidc-provider-name: gh-citrusleaf
8797
artifactory-oidc-audience: citrusleaf
88-
artifact-name: build-artifacts
98+
artifact-name: signed-artifacts
8999
retention-days: 1
90100
dry-run: false
91101
```

‎.github/workflows/execute-build/README.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,13 @@ This workflow executes a custom build script and uploads the resulting artifacts
1212
| -------------------------------- | -------------------------------------------------------------------- | -------- | ------------------------------- |
1313
| `project` | JFrog Artifactory project name | Yes | - |
1414
| `build-name` | Name for this build in artifactory | Yes | - |
15-
| `build-version` | Version for this build in artifactory | Yes | - |
15+
| `build-id` | Build ID for this build in artifactory | Yes | - |
1616
| `build-script` | Inline bash commands to execute | No\* | - |
1717
| `build-script-path` | Path to the build script file to execute | No\* | - |
1818
| `artifact-directory` | Directory that will contain all artifacts from this build | Yes | - |
1919
| `artifact-name` | Name for the uploaded artifacts | No | `build-artifacts` |
2020
| `retention-days` | Retention days for the artifacts | No | `1` |
21+
| `working-directory` | Working directory for build script execution | No | - |
2122
| `artifactory-url` | JFrog Artifactory URL | No | `https://artifact.aerospike.io` |
2223
| `artifactory-oidc-provider-name` | OIDC provider name | No | `gh-aerospike` |
2324
| `artifactory-oidc-audience` | OIDC audience | No | `aerospike` |
@@ -47,7 +48,7 @@ jobs:
4748
with:
4849
project: my-project
4950
build-name: my-app
50-
build-version: v1.0.0
51+
build-id: 1234567890
5152
build-script: make clean && make all && cp build/* dist/
5253
artifact-directory: dist
5354
artifact-name: my-build-artifacts
@@ -64,7 +65,7 @@ jobs:
6465
with:
6566
project: my-project
6667
build-name: my-app
67-
build-version: v1.0.0
68+
build-id: 1234567890
6869
build-script-path: ./scripts/build.sh
6970
artifact-directory: dist
7071
artifact-name: my-build-artifacts

0 commit comments

Comments
 (0)