Skip to content

Commit 82eef8e

Browse files
committed
ci: improve release notes for gather-info workflow
1 parent 864cb66 commit 82eef8e

1 file changed

Lines changed: 30 additions & 1 deletion

File tree

.github/workflows/release-gather-info.yml

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,40 @@ jobs:
6666
./gather-info --version
6767
file gather-info | grep -q "statically linked"
6868
69+
- name: Generate release body
70+
id: body
71+
run: |
72+
VERSION="${GITHUB_REF_NAME#gather-info/}"
73+
cat <<BODY > release-body.md
74+
## gather-info ${VERSION}
75+
76+
### Usage
77+
78+
\`\`\`bash
79+
chmod +x gather-info
80+
sudo ./gather-info
81+
\`\`\`
82+
83+
### Verify download
84+
85+
\`\`\`bash
86+
sha256sum -c gather-info.sha256
87+
\`\`\`
88+
89+
### What's included
90+
91+
Static Linux x86_64 binary. Collects system, network, NVIDIA GPU, DCGM, Docker, services, journal, packages, storage, and InfiniBand diagnostics into a single \`.tar.gz\` archive.
92+
93+
See [CODEMAP.md](https://github.com/${{ github.repository }}/blob/${{ github.sha }}/customers/vm-troubleshooting/CODEMAP.md) for architecture details.
94+
BODY
95+
# Strip leading whitespace from heredoc indentation
96+
sed -i 's/^ //' release-body.md
97+
6998
- name: Release
7099
uses: softprops/action-gh-release@v2
71100
with:
72101
name: "gather-info ${{ github.ref_name }}"
73-
generate_release_notes: true
102+
body_path: customers/vm-troubleshooting/release-body.md
74103
# Paths relative to repo root (working-directory does not apply to uses steps)
75104
files: |
76105
customers/vm-troubleshooting/gather-info

0 commit comments

Comments
 (0)