Skip to content

ci: improve the template of the GitHub release #593

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jan 28, 2025
Merged

ci: improve the template of the GitHub release #593

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
26ee9f2
ci: improve the template of the GH release
tbouffard Nov 30, 2024
3875bc1
Add links to examples and documentation
tbouffard Dec 1, 2024
b7b62e6
improve text of links
tbouffard Dec 1, 2024
4bdb001
TMP: test the milestone retrieval in GHA
tbouffard Jan 28, 2025
7a28b9f
TMP wf: use gh token
tbouffard Jan 28, 2025
2bf5a8d
restore build.yml definition
tbouffard Jan 28, 2025
44a5ecf
wf: dynamically retrieve the milestone number [skip ci]
tbouffard Jan 28, 2025
00f80d4
wf: all log for the retrieval of the milestone number [skip ci]
tbouffard Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 27 additions & 5 deletions .github/workflows/create-github-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,22 @@ jobs:
- name: Set env
run: |
echo "VERSION=${GITHUB_REF_NAME#v}" >> $GITHUB_ENV
- name: Get milestone number
env:
GH_TOKEN: ${{ github.token }}
run: |
echo "Fetching milestone for version ${{ env.VERSION }}..."
MILESTONE_NUMBER=$(gh api graphql -f query='
query($version: String!) {
repository(owner: "${{ github.repository_owner }}", name: "${{ github.event.repository.name }}) {
milestones(first: 1, query: $version) {
nodes { number }
}
}
}' -f version="${{ env.VERSION }}" --jq '.data.repository.milestones.nodes[0].number')
echo "Found milestone: ${MILESTONE_NUMBER}"
echo "MILESTONE_NUMBER=${MILESTONE_NUMBER:-x}" >> $GITHUB_ENV

- name: Create release
uses: ncipollo/release-action@v1
with:
Expand All @@ -23,10 +39,15 @@ jobs:

_If appropriate, briefly explain the contents of the new version._

npm package: [${{ env.VERSION }}](https://www.npmjs.com/package/@maxgraph/core/v/${{ env.VERSION }})
**Update the milestone URL**
Fixed issues: [milestone ${{ env.VERSION }}](https://github.com/maxGraph/maxGraph/milestone/x?closed=1)
See also the [Changelog](https://github.com/maxGraph/maxGraph/tree/v${{ env.VERSION }}/CHANGELOG.md) file.
## Resources

**TODO: Validate the milestone URL and update it if needed**

- **npm package**: [@maxgraph/core ${{ env.VERSION }}](https://www.npmjs.com/package/@maxgraph/core/v/${{ env.VERSION }})
- **Fixed issues**: [milestone ${{ env.VERSION }}](https://github.com/maxGraph/maxGraph/milestone/${{ env.MILESTONE_NUMBER }}?closed=1)
- **Documentation**: [maxgraph_${{ env.VERSION }}_website.zip](https://github.com/maxGraph/maxGraph/releases/download/v${{ env.VERSION }}/maxgraph_${{ env.VERSION }}_website.zip)
- **Examples**: [maxgraph_${{ env.VERSION }}_examples.zip](https://github.com/maxGraph/maxGraph/releases/download/v${{ env.VERSION }}/maxgraph_${{ env.VERSION }}_examples.zip)
- **Changelog** (only includes a summary and breaking changes): [changelog](https://github.com/maxGraph/maxGraph/tree/v${{ env.VERSION }}/CHANGELOG.md)


## Breaking changes
Expand Down Expand Up @@ -63,7 +84,8 @@ jobs:

some explanations....

ℹ️ For more details, see #<PR_NUMBER>.
> [!NOTE]
> For more details, see #<PR_NUMBER>.

### Other changes.... adapt and create more paragraphs
draft: true
Expand Down