chore(pipeline): run build of github pages on pullRequests (#3607)

Co-authored-by: Morgan Bazalgette <[email protected]>

.github/workflows/gh-pages.yml

@@ -1,11 +1,14 @@
 # generate Go docs and publish on gh-pages branch
 # Live at: https://gnolang.github.io/gno
-name: Go Reference Docs Deployment
+name: GitHub pages (godoc & stdlib_diff) build and deploy
 
 on:
   push:
     branches:
       - master
+  pull_request:
+    branches:
+      - master
   workflow_dispatch:
 
 permissions:
@@ -19,29 +22,39 @@ concurrency:
 
 jobs:
   build:
-    if: ${{ github.repository == 'gnolang/gno' }} # Alternatively, validate based on provided tokens and permissions.
+    if: github.repository == 'gnolang/gno' # Alternatively, validate based on provided tokens and permissions.
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-go@v5
         with:
           go-version-file: go.mod
-      - run: echo "GOROOT=$(go env GOROOT)" >> $GITHUB_ENV
-      - run: echo $GOROOT
+      # Use the goroot at the top of the project to compare with the GnoVM
+      # stdlib, rather than the one in stdlib_diff (which may have a go.mod with
+      # a different toolchain version).
+      - run: echo "GOROOT_SAVE=$(go env GOROOT)" >> $GITHUB_ENV
       - run: "cd misc/stdlib_diff && make gen"
       - run: "cd misc/gendocs && make install gen"
       - run: "mkdir -p pages_output/stdlib_diff"
       - run: |
           cp -r misc/gendocs/godoc/* pages_output/
           cp -r misc/stdlib_diff/stdlib_diff/* pages_output/stdlib_diff/
+
+      # These two last steps will be skipped on pull requests
       - uses: actions/configure-pages@v5
         id: pages
+        if: github.event_name != 'pull_request'
+
       - uses: actions/upload-pages-artifact@v3
+        if: github.event_name != 'pull_request'
         with:
           path: ./pages_output
 
   deploy:
-    if: ${{ github.repository == 'gnolang/gno' }} # Alternatively, validate based on provided tokens and permissions.
+    if: >
+      github.repository == 'gnolang/gno' &&
+      github.ref == 'refs/heads/master' &&
+      github.event_name == 'push'
     runs-on: ubuntu-latest
     environment:
       name: github-pages

misc/stdlib_diff/Makefile

@@ -1,7 +1,9 @@
 all: clean gen
 
+GOROOT_SAVE ?= $(shell go env GOROOT)
+
 gen:
-	go run . -src $(GOROOT)/src -dst ../../gnovm/stdlibs -out ./stdlib_diff
+	go run . -src $(GOROOT_SAVE)/src -dst ../../gnovm/stdlibs -out ./stdlib_diff
 
 clean:
 	rm -rf stdlib_diff

misc/stdlib_diff/README.md

@@ -1,6 +1,6 @@
 # stdlibs_diff
 
-stdlibs_diff is a tool that generates an html report indicating differences between gno standard libraries and go standrad libraries
+stdlibs_diff is a tool that generates an html report indicating differences between gno standard libraries and go standard libraries.
 
 ## Usage
 
@@ -27,4 +27,4 @@ Compare the `gno` standard libraries the `go` standard libraries
 
 ## Tips
 
-An index.html is generated at the root of the report location. Utilize it to navigate easily through the report.
+An index.html is generated at the root of the report location. Utilize it to navigate easily through the report.