Skip to content

Commit 1665daa

Browse files
committed
chore(release): improve generated release notes
1 parent 80b5f96 commit 1665daa

1 file changed

Lines changed: 25 additions & 2 deletions

File tree

.github/workflows/release.yml

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,8 @@ jobs:
150150
steps:
151151
- name: Checkout code
152152
uses: actions/checkout@v4
153+
with:
154+
fetch-depth: 0
153155

154156
- name: Download all build artifacts
155157
uses: actions/download-artifact@v4
@@ -204,6 +206,15 @@ jobs:
204206
RELEASE_TYPE_BADGE=" (Pre-release)"
205207
fi
206208
209+
VERSION_TAG="v${VERSION}"
210+
PREVIOUS_TAG=$(git tag -l 'v*' --sort=-version:refname | grep -vx "${VERSION_TAG}" | head -n 1)
211+
CHANGELOG_URL="https://github.com/${{ github.repository }}/blob/${{ github.sha }}/CHANGELOG.md"
212+
COMPARE_URL=""
213+
214+
if [[ -n "$PREVIOUS_TAG" ]]; then
215+
COMPARE_URL="https://github.com/${{ github.repository }}/compare/${PREVIOUS_TAG}...${VERSION_TAG}"
216+
fi
217+
207218
cat > RELEASE_NOTES.md << EOF
208219
# FlashForgeWebUI v${VERSION}${RELEASE_TYPE_BADGE}
209220
@@ -233,6 +244,9 @@ jobs:
233244
./flashforge-webui-linux-x64.bin
234245
\`\`\`
235246
247+
After startup, open \`http://localhost:3000\` in your browser by default.
248+
The default password is \`changeme\` unless you override it in your config or via \`--webui-password\`.
249+
236250
Or use CLI options to auto-connect to printers:
237251
\`\`\`bash
238252
# Connect to last used printer
@@ -248,11 +262,20 @@ jobs:
248262
./flashforge-webui-linux-x64.bin --webui-port=3001 --webui-password=mypassword
249263
\`\`\`
250264
251-
See the [README](https://github.com/Parallel-7/FlashForgeWebUI) for full documentation.
265+
## More Information
252266
267+
- [README](https://github.com/${{ github.repository }}) for full documentation
268+
- [CHANGELOG](${CHANGELOG_URL}) for the full release history
253269
EOF
254270
255-
echo "VERSION_TAG=v${VERSION}" >> $GITHUB_ENV
271+
if [[ -n "$COMPARE_URL" ]]; then
272+
cat >> RELEASE_NOTES.md << EOF
273+
- [Compare changes since ${PREVIOUS_TAG}](${COMPARE_URL})
274+
275+
EOF
276+
fi
277+
278+
echo "VERSION_TAG=${VERSION_TAG}" >> $GITHUB_ENV
256279
echo "RELEASE_NAME=FlashForgeWebUI v${VERSION}${RELEASE_TYPE_BADGE}" >> $GITHUB_ENV
257280
echo "RELEASE_NOTES_PATH=RELEASE_NOTES.md" >> $GITHUB_ENV
258281

0 commit comments

Comments
 (0)