Skip to content

Commit 4b248b8

Browse files
committed
Improve release notes with direct download links
Updated the release notes generation in the GitHub Actions workflow to include direct download links for each platform and architecture, clearer installation instructions, and improved formatting. This makes it easier for users to find and verify the correct installer for their system.
1 parent 6d9b2e3 commit 4b248b8

1 file changed

Lines changed: 35 additions & 33 deletions

File tree

.github/workflows/release.yml

Lines changed: 35 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -119,58 +119,60 @@ jobs:
119119
- name: Generate release notes
120120
id: release_notes
121121
run: |
122-
cat > release_notes.md << 'EOF'
123-
## Dockyard ${{ steps.get_version.outputs.VERSION }}
122+
VERSION="${{ steps.get_version.outputs.VERSION }}"
123+
cat > release_notes.md << EOF
124+
## Dockyard ${VERSION}
124125
125126
A local-first multi-app workspace powered by Electron.
126127
127-
### Installation
128+
### Download
128129
129-
Download the artifact for your platform from the Assets section below.
130+
Choose the installer for your platform:
130131
131132
#### macOS
132-
- Use the `.dmg` to install (drag Dockyard to Applications)
133-
- OR use a `.zip`/packaged binary if provided.
133+
- **Apple Silicon (M1/M2/M3)**: [Dockyard-${VERSION#v}-arm64.dmg](https://github.com/MayR-Labs/dockyard-electron/releases/download/${VERSION}/Dockyard-${VERSION#v}-arm64.dmg)
134+
- **Intel (x64)**: [Dockyard-${VERSION#v}-x64.dmg](https://github.com/MayR-Labs/dockyard-electron/releases/download/${VERSION}/Dockyard-${VERSION#v}-x64.dmg)
135+
136+
**Important**: After installation, remove macOS quarantine:
137+
\`\`\`bash
138+
curl -sSL https://raw.githubusercontent.com/MayR-Labs/dockyard-electron/main/scripts/mac-first-run.sh | bash
139+
\`\`\`
134140
135141
#### Windows
136-
- Run the Squirrel installer (`DockyardSetup.exe`) or similar `.exe`.
142+
- **Installer**: [Dockyard-${VERSION#v}.Setup.exe](https://github.com/MayR-Labs/dockyard-electron/releases/download/${VERSION}/Dockyard-${VERSION#v}.Setup.exe)
137143
138144
#### Linux
139-
- Debian/Ubuntu: Install the `.deb` package
140-
```bash
141-
sudo dpkg -i dockyard-electron_*.deb || sudo apt -f install
142-
```
143-
- Fedora/RHEL: Install the `.rpm` package
144-
```bash
145-
sudo rpm -i dockyard-electron-*.rpm
146-
```
147-
148-
### Verify Installation
149-
Launch Dockyard. From the Dockyard menu (or terminal if using a binary), check the version matches the tag:
150-
```bash
151-
# If a CLI wrapper becomes available in future
152-
Dockyard --version
153-
```
145+
- **Debian/Ubuntu**: [dockyard_${VERSION#v}_amd64.deb](https://github.com/MayR-Labs/dockyard-electron/releases/download/${VERSION}/dockyard_${VERSION#v}_amd64.deb)
146+
\`\`\`bash
147+
sudo dpkg -i dockyard_${VERSION#v}_amd64.deb
148+
# Fix dependencies if needed:
149+
sudo apt -f install
150+
\`\`\`
151+
- **Fedora/RHEL**: [dockyard-${VERSION#v}-1.x86_64.rpm](https://github.com/MayR-Labs/dockyard-electron/releases/download/${VERSION}/dockyard-${VERSION#v}-1.x86_64.rpm)
152+
\`\`\`bash
153+
sudo rpm -i dockyard-${VERSION#v}-1.x86_64.rpm
154+
\`\`\`
154155
155156
### Checksums
156-
Verify integrity of downloaded files using the provided SHA-256 checksums:
157-
```bash
158-
# Example (replace <file>)
159-
sha256sum <file>
160-
# or on macOS
161-
shasum -a 256 <file>
162-
```
163-
Compare the output to the corresponding entry in `checksums.txt`.
157+
Verify file integrity using SHA-256:
158+
\`\`\`bash
159+
# Linux
160+
sha256sum <downloaded-file>
161+
# macOS
162+
shasum -a 256 <downloaded-file>
163+
\`\`\`
164+
Compare with checksums below or in \`checksums.txt\`.
164165
165166
### What's Changed
166-
See the [CHANGELOG](https://github.com/MayR-Labs/dockyard-electron/blob/main/CHANGELOG.md) for detailed updates (if available).
167+
See the [CHANGELOG](https://github.com/MayR-Labs/dockyard-electron/blob/main/CHANGELOG.md) for detailed updates.
167168
168169
### Transparency & Privacy
169170
Dockyard is local-first with no telemetry. Review the source at any time.
171+
172+
### Artifact Checksums (SHA-256)
173+
\`\`\`text
170174
EOF
171175
# Append checksums inline for convenience
172-
echo "\n### Artifact Checksums (SHA-256)" >> release_notes.md
173-
echo '\n```text' >> release_notes.md
174176
cat collected/checksums.txt >> release_notes.md
175177
echo '```' >> release_notes.md
176178
cat release_notes.md

0 commit comments

Comments
 (0)