Skip to content
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

fix(ci): duplicated Netlify deployment URL being posted #52

Merged
merged 4 commits into from
Jan 16, 2024
Merged

fix(ci): duplicated Netlify deployment URL being posted #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8539407
fix(ci): duplicated Netlify deployment URL being posted
nekomeowww Jan 16, 2024
960567c
fix(ci): use workflow_run
nekomeowww Jan 16, 2024
a20b0ff
fix(ci): use workflow_run
nekomeowww Jan 16, 2024
8416674
fix(ci): use workflow_run
nekomeowww Jan 16, 2024
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
59 changes: 59 additions & 0 deletions .github/workflows/docs-build.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Build Previewing Docs

on:
pull_request:
branches:
- main

jobs:
build:
strategy:
matrix:
os: [ubuntu-latest, windows-latest]

name: Build - ${{ matrix.os }}

runs-on: ${{ matrix.os }}
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Install Node.js 20.x
uses: actions/setup-node@v3
with:
node-version: 20.x

- name: Install pnpm
uses: pnpm/action-setup@v2
with:
run_install: false
version: 8

- name: Obtain pnpm store directory
shell: bash
run: |
echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV

- name: Obtain pnpm store cache
uses: actions/cache@v3
with:
path: ${{ env.STORE_PATH }}
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
restore-keys: |
${{ runner.os }}-pnpm-store-

- name: Install dependencies
run: pnpm install --frozen-lockfile

- name: Build docs
run: |
pnpm packages:build
pnpm docs:build

- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: docs-${{ matrix.os }}-build
path: docs/.vitepress/dist
156 changes: 84 additions & 72 deletions .github/workflows/preview-docs-deployment.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,54 +1,37 @@
name: Build Preview Docs to Netlify
name: Push Previewing Docs to Netlify

on:
pull_request:
branches:
- main
pull_request_target:
workflow_run:
workflows:
- Build Previewing Docs
types:
- opened
- synchronize
- reopened
branches:
- main
- completed

jobs:
build:
strategy:
matrix:
os: [ubuntu-latest, windows-latest]

name: Build - ${{ matrix.os }}

runs-on: ${{ matrix.os }}
on-success:
name: Deploy to Netlify
runs-on: ubuntu-latest
permissions:
pull-requests: write
if: ${{ github.event.workflow_run.conclusion == 'success' }}
steps:
- name: Find Comment
uses: peter-evans/find-comment@v2
id: fc
- name: Download artifact - Ubuntu
uses: dawidd6/action-download-artifact@v3
with:
issue-number: ${{ github.event.pull_request.number }}
comment-author: 'github-actions[bot]'
body-includes: to Netlify - ${{ matrix.os }}
token: ${{ secrets.ACCESS_TOKEN_GITHUB }}

- name: Create or update comment
uses: peter-evans/create-or-update-comment@v3
with:
comment-id: ${{ steps.fc.outputs.comment-id }}
issue-number: ${{ github.event.pull_request.number }}
body: |
## 🚧 Deploying to Netlify - ${{ matrix.os }}

| Status | URL |
|-------------|--------------------------------------|
| Pending | `URL will be revealed once deployed` |
edit-mode: replace
token: ${{ secrets.ACCESS_TOKEN_GITHUB }}

- name: Checkout
uses: actions/checkout@v3
workflow_conclusion: success
run_id: ${{ github.event.workflow_run.id }}
name: docs-ubuntu-latest-build
path: docs-ubuntu-latest-build
allow_forks: true

- name: Download artifact - Windows
uses: dawidd6/action-download-artifact@v3
with:
fetch-depth: 0
workflow_conclusion: success
run_id: ${{ github.event.workflow_run.id }}
name: docs-windows-latest-build
path: docs-windows-latest-build
allow_forks: true

- name: Install Node.js 20.x
uses: actions/setup-node@v3
Expand All @@ -74,60 +57,89 @@ jobs:
restore-keys: |
${{ runner.os }}-pnpm-store-

- name: Install dependencies
run: pnpm install --frozen-lockfile

- name: Build docs
run: |
pnpm packages:build
pnpm docs:build

- name: Install Netlify CLI
run: pnpm install -g netlify-cli

- name: Push to Netlify - Linux
- name: Debug
run:
ls -la
ls -la docs-ubuntu-latest-build
ls -la docs-windows-latest-build

- name: Push to Netlify - Ubuntu
id: netlify-ubuntu-latest
timeout-minutes: 10
working-directory: docs/
if : ${{ matrix.os == 'ubuntu-latest' }}
run: |
NETLIFY_JSON_OUTPUT=$(netlify deploy --dir .vitepress/dist --json)
NETLIFY_JSON_OUTPUT=$(netlify deploy --dir docs-ubuntu-latest --json)
echo $NETLIFY_JSON_OUTPUT

echo "NETLIFY_JSON_OUTPUT=$(echo $NETLIFY_JSON_OUTPUT)" >> $GITHUB_ENV
echo "NETLIFY_URL=$(echo $NETLIFY_JSON_OUTPUT | jq -r .deploy_url)" >> $GITHUB_ENV
cat $GITHUB_ENV
env:
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}

- name: Push to Netlify - Windows
id: netlify-windows-latest
timeout-minutes: 10
working-directory: docs\
if : ${{ matrix.os == 'windows-latest' }}
run: |
$NETLIFY_JSON_OUTPUT = netlify deploy --dir '.vitepress\dist' --json
Write-Host $NETLIFY_JSON_OUTPUT
Write-Host "NETLIFY_JSON_OUTPUT=$NETLIFY_JSON_OUTPUT" | Out-File -Append $env:GITHUB_ENV

# Parse JSON output and extract deploy_url
$ParsedJson = $NETLIFY_JSON_OUTPUT | ConvertFrom-Json
$NETLIFY_URL = $ParsedJson.deploy_url
NETLIFY_JSON_OUTPUT=$(netlify deploy --dir docs-windows-latest-build --json)

"NETLIFY_URL=$NETLIFY_URL" | Out-File -Append $env:GITHUB_ENV
Get-Content $env:GITHUB_ENV
echo $NETLIFY_JSON_OUTPUT
echo "NETLIFY_JSON_OUTPUT=$(echo $NETLIFY_JSON_OUTPUT)" >> $GITHUB_ENV
echo "NETLIFY_URL=$(echo $NETLIFY_JSON_OUTPUT | jq -r .deploy_url)" >> $GITHUB_ENV
env:
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}

- name: Find Comment
uses: peter-evans/find-comment@v2
id: fc
with:
issue-number: ${{ github.event.pull_request.number }}
comment-author: 'github-actions[bot]'
body-includes: to Netlify

- name: Create or update comment
uses: peter-evans/create-or-update-comment@v3
with:
comment-id: ${{ steps.fc.outputs.comment-id }}
issue-number: ${{ github.event.pull_request.number }}
body: |
## ✅ Deployed to deploy to Netlify

| Platform | Status | URL |
|----------|-------------|---------------------------------------------------------|
| Windows | Success | ${{ steps.netlify-ubuntu-latest.outputs.NETLIFY_URL }} |
| Unix | Success | ${{ steps.netlify-windows-latest.outputs.NETLIFY_URL }} |
edit-mode: replace

on-failure:
name: Failed to build previewing docs
runs-on: ubuntu-latest
permissions:
pull-requests: write

if: ${{ github.event.workflow_run.conclusion == 'failure' }}
steps:
- name: Find Comment
uses: peter-evans/find-comment@v2
id: fc
with:
issue-number: ${{ github.event.pull_request.number }}
comment-author: 'github-actions[bot]'
body-includes: to Netlify

- name: Create or update comment
uses: peter-evans/create-or-update-comment@v3
with:
comment-id: ${{ steps.fc.outputs.comment-id }}
issue-number: ${{ github.event.pull_request.number }}
body: |
## ✅ Deployed to Netlify - ${{ matrix.os }}
## ❌ Failed to deploy to Netlify

| Status | URL |
|-------------|-----------------------------------------------------|
| Success | ${{ env.NETLIFY_URL }} |
| Platform | Status | URL |
|----------|-------------|-------------------------------------------------------|
| Windows | Failed | Please check the status and logs of the workflow run. |
| Unix | Failed | Please check the status and logs of the workflow run. |
edit-mode: replace
token: ${{ secrets.ACCESS_TOKEN_GITHUB }}
Loading