-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Setup new deployment and pr preview deployments (#21)
# Description As a non-technical (or technical) reviewer of site changes, I want to see the site running so that I can see how it actually works. - Closes #20 ## Screenshot(s) ## Type of change - [x] CI/Dependencies/etc... # How to Test? Please describe how to test that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration 1. Check the Actions results 2. See that the site is still live! - Deployment of root: https://github.com/frequency-chain/frequency-xyz/actions/runs/11145981761 - PR preview deployment: https://github.com/frequency-chain/frequency-xyz/actions/runs/11146209046 - PR Preview Removal Test coming once this PR merges: ... # Checklist: - [x] I have performed a self-review of my code - [x] I have commented my code & PR, particularly in hard-to-understand areas
- Loading branch information
Showing
6 changed files
with
183 additions
and
36 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| # yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json | ||
| name: Remove PR Deploy Preview | ||
|
|
||
| on: | ||
| pull_request: | ||
| types: [closed] | ||
|
|
||
| permissions: | ||
| contents: write | ||
|
|
||
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||
| concurrency: | ||
| group: 'deploy-pages' | ||
| cancel-in-progress: false | ||
|
|
||
| jobs: | ||
| cleanup: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| ref: gh-pages | ||
|
|
||
| - name: Remove PR preview | ||
| run: | | ||
| PR_NUMBER=${{ github.event.pull_request.number }} | ||
| if [ -d "_pr/$PR_NUMBER" ]; then | ||
| git config user.name github-actions | ||
| git config user.email github-actions@github.com | ||
| git rm -rf "_pr/$PR_NUMBER" | ||
| git commit -m "Remove PR preview for #$PR_NUMBER" | ||
| git push | ||
| else | ||
| echo "Preview folder for PR #$PR_NUMBER does not exist. Skipping cleanup." | ||
| fi | ||
| - name: Update Job Summary | ||
| run: | | ||
| echo "## Cleanup Summary" >> $GITHUB_STEP_SUMMARY | ||
| echo "🧹 Removed preview for PR #${{ github.event.pull_request.number }}" >> $GITHUB_STEP_SUMMARY |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| # yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json | ||
| name: PR Deploy Preview | ||
|
|
||
| # Preview PRs via actions/deploy-pages is not available so using JamesIves/github-pages-deploy-action | ||
| # https://github.com/orgs/community/discussions/7730 | ||
|
|
||
| on: | ||
| pull_request: | ||
|
|
||
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
| permissions: | ||
| contents: write | ||
| pull-requests: write | ||
| id-token: write | ||
|
|
||
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||
| concurrency: | ||
| group: 'deploy-pages' | ||
| cancel-in-progress: false | ||
|
|
||
| jobs: | ||
| deploy-preview: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Install Node.js | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 20 | ||
| cache: npm | ||
|
|
||
| - name: Install dependencies | ||
| run: npm install | ||
|
|
||
| - name: Build | ||
| env: | ||
| # Deploying to a root domain | ||
| BASE_PATH: /_pr/${{ github.event.pull_request.number }} | ||
| run: | | ||
| npm run build | ||
| touch build/.nojekyll | ||
| - name: Deploy to GitHub Pages | ||
| uses: JamesIves/github-pages-deploy-action@881db5376404c5c8d621010bcbec0310b58d5e29 | ||
| with: | ||
| folder: build | ||
| target-folder: _pr/${{ github.event.pull_request.number }} | ||
|
|
||
| - name: Update Job Summary | ||
| run: | | ||
| echo "## Preview URL" >> $GITHUB_STEP_SUMMARY | ||
| echo "🚀 [https://www.frequency.xyz/_pr/${{ github.event.pull_request.number }}](https://www.frequency.xyz/_pr/${{ github.event.pull_request.number }})" >> $GITHUB_STEP_SUMMARY | ||
| - name: Comment PR | ||
| uses: actions/github-script@v6 | ||
| with: | ||
| github-token: ${{secrets.GITHUB_TOKEN}} | ||
| script: | | ||
| const prNumber = context.issue.number; | ||
| const sha = context.sha; | ||
| const deploymentUrl = `https://www.frequency.xyz/_pr/${prNumber}/`; | ||
| const commitUrl = `https://github.com/${context.repo.owner}/${context.repo.repo}/commit/${sha}`; | ||
| const body = `🚀 Preview deployment for this PR is going up! Remember you might need to hard refresh to get the new content.\n\nPreview URL: [${deploymentUrl}](${deploymentUrl})\nCommit: [${sha.substr(0, 7)}](${commitUrl})`; | ||
| const comments = await github.rest.issues.listComments({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| issue_number: prNumber, | ||
| }); | ||
| const existingComment = comments.data.find(comment => | ||
| comment.user.login === 'github-actions[bot]' && | ||
| comment.body.includes('Preview deployment for this PR is ready!') | ||
| ); | ||
| if (existingComment) { | ||
| await github.rest.issues.updateComment({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| comment_id: existingComment.id, | ||
| body: body, | ||
| }); | ||
| } else { | ||
| await github.rest.issues.createComment({ | ||
| owner: context.repo.owner, | ||
| repo: context.repo.repo, | ||
| issue_number: prNumber, | ||
| body: body, | ||
| }); | ||
| } |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,11 @@ | ||
| <script type="ts"> | ||
| import { base } from '$app/paths'; | ||
| </script> | ||
|
|
||
| <footer class="freq-container flex h-[50px] items-center justify-end gap-3 text-xs font-semibold"> | ||
| <div>© {new Date().getFullYear()} Frequency Network Foundation</div> | ||
| <span class="h-4 w-[2px] bg-black" /> | ||
| <a href="/privacy">Privacy Policy</a> | ||
| <a href="{base}/privacy">Privacy Policy</a> | ||
| <span class="h-4 w-[2px] bg-black" /> | ||
| <div class="whitespace-nowrap">All Rights Reserved</div> | ||
| </footer> |
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| User-agent: * | ||
| Disallow: | ||
| Disallow: /_pr/ |