feat: host celestia-node/app release notes as searchable individual pages #2259
+906
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Create TypeScript script to generate release pages from GitHub API - Add directory structure for celestia-node and celestia-app releases - Update VitePress config to include releases in sidebar navigation - Add GitHub Actions workflow for automatic updates - Create comprehensive documentation and README - Generate sample release pages for testing Co-authored-by: jcstein <[email protected]>
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Comment on lines
+28
to
+90
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 18 | ||
| cache: yarn | ||
|
|
||
| - name: Install dependencies | ||
| run: yarn install --frozen-lockfile | ||
|
|
||
| - name: Generate release pages | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| run: | | ||
| if [ "${{ github.event.inputs.node_only }}" = "true" ]; then | ||
| yarn generate-releases --node | ||
| elif [ "${{ github.event.inputs.app_only }}" = "true" ]; then | ||
| yarn generate-releases --app | ||
| else | ||
| yarn generate-releases | ||
| fi | ||
| - name: Check for changes | ||
| id: changes | ||
| run: | | ||
| if git diff --quiet docs/releases/; then | ||
| echo "changed=false" >> $GITHUB_OUTPUT | ||
| else | ||
| echo "changed=true" >> $GITHUB_OUTPUT | ||
| fi | ||
| - name: Commit and push changes | ||
| if: steps.changes.outputs.changed == 'true' | ||
| run: | | ||
| git config --local user.email "[email protected]" | ||
| git config --local user.name "GitHub Action" | ||
| git add docs/releases/ | ||
| git commit -m "chore: update release pages [skip ci]" | ||
| git push | ||
| - name: Build VitePress site | ||
| if: steps.changes.outputs.changed == 'true' | ||
| run: yarn build | ||
|
|
||
| - name: Comment on completion | ||
| if: steps.changes.outputs.changed == 'true' && github.event_name == 'workflow_dispatch' | ||
| uses: actions/github-script@v7 | ||
| with: | ||
| script: | | ||
| github.rest.repos.createCommitComment({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| commit_sha: context.sha, | ||
| body: '✅ Release pages have been updated successfully!' | ||
| }) No newline at end of file |
Check warning
Code scanning / CodeQL
Workflow does not contain permissions Medium
Show autofix suggestion
Hide autofix suggestion
Copilot Autofix
AI 7 days ago
To fix the problem, explicitly set a permissions block at either the job or workflow root. Since this workflow commits and pushes to the repository, it requires contents: write. Other permissions can be kept at their default (none), unless more scoped write permissions are needed. The most direct fix is to add permissions: contents: write to the update-releases job definition (line 28), immediately before runs-on. This ensures only the necessary privileges are granted to the GITHUB_TOKEN during this job's execution.
- Edit region: Add
permissions:just beforeruns-on: ubuntu-latestin theupdate-releasesjob. - No import or definition changes needed.
- No functionality changes; this only affects the security posture.
Suggested changeset
1
.github/workflows/update-releases.yml
| @@ -25,6 +25,8 @@ | ||
|
|
||
| jobs: | ||
| update-releases: | ||
| permissions: | ||
| contents: write | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: |
Copilot is powered by AI and may make mistakes. Always verify output.
Copilot
AI
changed the title
Copilot finished work on behalf of
jcstein
October 7, 2025 14:40
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR implements the feature requested in the issue to host release notes for both celestia-node and celestia-app as individual markdown pages within the VitePress documentation site, making them fully searchable and linkable.
Overview
Creates a comprehensive release notes system that automatically generates individual pages for each GitHub release, with structured frontmatter and full integration into the documentation site's navigation and search.
Implementation
Directory Structure
Key Components
TypeScript Generation Script (
scripts/generate-release-pages.ts):--nodeand--appflagsStructured Frontmatter Schema:
VitePress Integration:
GitHub Actions Automation (
.github/workflows/update-releases.yml):Benefits
Usage
The implementation includes sample release pages demonstrating the functionality and is production-ready with proper error handling, GitHub API authentication support, and comprehensive documentation.
Closes #[issue-number]
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
https://api.github.com/repos/celestiaorg/celestia-node/releases/usr/local/bin/node --require /home/REDACTED/work/docs/docs/node_modules/tsx/dist/preflight.cjs --import file:///home/REDACTED/work/docs/docs/node_modules/tsx/dist/loader.mjs scripts/generate-release-pages.ts --node(http block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.