ci: refine pr-build workflow (#138)

* docs(getting-started): rename nightly build to pr-build * refactor(workflow): rename build-nightly -> pr-build * refactor(build): update workflow title from Build to Build (Stable) * ci: make context an independent job * Update .github/workflows/pr-build.yml --------- Co-authored-by: kunish <[email protected]>
daeuniverse · Jul 9, 2023 · d337ea8 · d337ea8
1 parent e0a3c6b
commit d337ea8
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 10 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -1,9 +1,12 @@
-name: Build
+name: Build (Stable)
 
 on:
   workflow_dispatch:
   push:
     branches: [main]
+    paths-ignore:
+      - '**/*.md'
+      - README.md
 
 jobs:
   checkout-full-src:

diff --git a/.github/workflows/build-nightly.yml → .github/workflows/pr-build.yml b/.github/workflows/build-nightly.yml → .github/workflows/pr-build.yml
@@ -1,18 +1,24 @@
-name: Build (Nightly)
+name: PR Build (Preview)
+run-name: '#${{ github.event.pull_request.number }} - ${{ github.event.pull_request.title }} @${{ github.event.pull_request.head.ref }}:${{ github.event.pull_request.head.sha }}'
 
 on:
   workflow_dispatch:
-  push:
-    branches:
-      - hotfix-*
-      - test-pr-*
+  pull_request:
+    types: [opened, synchronize, reopened]
     paths-ignore:
       - '**/*.md'
       - README.md
-  pull_request:
-    types: [opened, synchronize, reopened]
 
 jobs:
+  context:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: |
+          echo "$GITHUB_CONTEXT"
+
   checkout-full-src:
     runs-on: ubuntu-latest
     steps:

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -8,9 +8,9 @@
 
 Releases are available in <https://github.com/daeuniverse/daed/releases>
 
-> **Note**: If you would like to get a taste of new features, there are nightly (latest) builds available. Most of the time, newly proposed changes will be included in `PRs` and will be exported as cross-platform executable binaries in builds (GitHub Action Workflow Build). Noted that newly introduced features are sometimes buggy, do it at your own risk. However, we still highly encourage you to check out our latest builds as it may help us further analyze features stability and resolve potential bugs accordingly.
+> **Note**: If you would like to get a taste of new features, there are `PR Builds` available. Most of the time, newly proposed changes will be included in `PRs` and will be exported as cross-platform executable binaries in builds (GitHub Action Workflow Build). Noted that newly introduced features are sometimes buggy, do it at your own risk. However, we still highly encourage you to check out our latest builds as it may help us further analyze features stability and resolve potential bugs accordingly.
 
-Nightly builds are available in <https://github.com/daeuniverse/daed/actions/workflows/build-nightly.yml>
+PR-builds are available in <https://github.com/daeuniverse/daed/actions/workflows/pr-build.yml>
 
 ### Spin up server locally