Skip to content

Commit 10274ed

Browse files
[#118] Include README, license, and docs in the release zip
The publish folder uploaded by the Build action becomes the downloadable zip, so copy README.md, LICENSE.md and Documentation/ into it before the upload. Documentation is then available offline and matches the released version, instead of only being reachable through the --help URL.
1 parent f04ccb7 commit 10274ed

2 files changed

Lines changed: 8 additions & 1 deletion

File tree

‎.github/workflows/.build.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,13 @@ jobs:
6868
rm -f publish/${{ matrix.os }}/${{ matrix.arch }}-${{ env.environment }}/*.pdb
6969
shell: bash
7070

71+
- name: Add documentation to package
72+
run: |
73+
dest="publish/${{ matrix.os }}/${{ matrix.arch }}-${{ env.environment }}"
74+
cp README.md LICENSE.md "$dest/"
75+
cp -R Documentation "$dest/"
76+
shell: bash
77+
7178
- name: Upload artifact
7279
uses: actions/upload-artifact@v4
7380
with:

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ shared test data doubles as convenient sample content for ad hoc use of the tool
122122

123123
## Downloads
124124

125-
Prebuilt Windows and Mac builds are published on the [Releases page](https://github.com/Unity-Technologies/UnityDataTools/releases). Each release includes a zip per platform containing the `UnityDataTool` executable and the native libraries it needs.
125+
Prebuilt Windows and Mac builds are published on the [Releases page](https://github.com/Unity-Technologies/UnityDataTools/releases). Each release includes a zip per platform containing the `UnityDataTool` executable, the native libraries it needs, and this README plus the matching `Documentation/` folder so the docs are available offline.
126126

127127
To use:
128128
1. Download and unzip the build for your platform.

0 commit comments

Comments
 (0)