You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+40Lines changed: 40 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,6 +20,13 @@ A GitHub action for uploading build artifacts to Buildstash.
20
20
custom_build_number: '12345' # Optional custom build number
21
21
platform: 'android' # Assuming platform is Android, see Buildstash documentation for other platforms
22
22
stream: 'default' # Exact name of a build stream in your app
23
+
# Optional metadata artifacts (JSON format with optional descriptions)
24
+
metadata_artifacts: |
25
+
[
26
+
{"path": "metadata.json", "description": "Build metadata and version info"},
27
+
{"path": "changelog.md", "description": "Release notes and changes"},
28
+
{"path": "readme.txt"}
29
+
]
23
30
# Optional build associations
24
31
labels: |
25
32
to-review
@@ -30,6 +37,7 @@ A GitHub action for uploading build artifacts to Buildstash.
30
37
armv8
31
38
arm64v8
32
39
armv9
40
+
custom_target: 'my-custom-target' # Exact name of your custom target, associated with both app and platform
33
41
# Optional CI information
34
42
ci_pipeline: ${{ github.workflow }}
35
43
ci_run_id: ${{ github.run_id }}
@@ -47,6 +55,38 @@ A GitHub action for uploading build artifacts to Buildstash.
47
55
### Upload expansion file
48
56
You may also optionally pass in a single expansion file, if the platform / primary file supports it. For example, if you upload an .apk, you could upload an .obb with it. To do so set 'structure' to `file+expansion`, and pass in 'expansion_file_path'.
49
57
58
+
### Upload metadata files
59
+
Optional related metadata files can be uploaded alongside the binaries for your actual build. These may include SBOMs (SPDX / CycloneDX), build logs, test results, changelogs, etc.
60
+
61
+
**Format:** JSON array with `path` (required) and `description` (optional) fields.
62
+
63
+
**Examples:**
64
+
```yaml
65
+
# With descriptions
66
+
metadata_artifacts: |
67
+
[
68
+
{"path": "metadata.json", "description": "Build metadata and version info"},
69
+
{"path": "changelog.md", "description": "Release notes and changes"},
70
+
{"path": "sbom.spdx", "description": "Software Bill of Materials"}
**Note:** Maximum of 10 metadata files per upload. Additional files will be skipped with a warning.
89
+
50
90
### API key
51
91
You will need to generate an application specific API key, and save it as an [Actions secret](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions) in your repository.
0 commit comments