Add action to build and deploy Ruby docs

BaseSecrete · Sep 2, 2024 · 900642c · 900642c
1 parent dedf7d4
commit 900642c
Show file tree

Hide file tree

Showing 2 changed files with 62 additions and 17 deletions.
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
@@ -2,7 +2,7 @@ name: Deploy RDoc site to Pages
 
 on:
   push:
-    branches: [ 'ruby-docs' ]
+    branches: [ 'master' ]
   workflow_dispatch:
 
 permissions:
@@ -17,17 +17,10 @@ concurrency:
 jobs:
   build:
     runs-on: ubuntu-latest
-    if: ${{ github.repository == 'basesecrete/rdoc' && !startsWith(github.event_name, 'pull') }}
+    if: ${{ github.repository == 'ruby/rdoc' && !startsWith(github.event_name, 'pull') }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-
-      - name: Checkout Ruby
-        uses: actions/checkout@v4
-        with:
-          repository: ruby/ruby
-          path: ruby
-
       - name: Setup Ruby
         uses: ruby/setup-ruby@161cd54b698f1fb3ea539faab2e036d409550e3c # v1.187.0
         with:
@@ -38,14 +31,7 @@ jobs:
         uses: actions/configure-pages@v5
       - name: Build with RDoc
         # Outputs to the './_site' directory by default
-        #run: bundle exec rake rdoc
-        run: |
-          bundle
-          echo "rake generate"
-          bundle exec rake generate
-          echo "rdoc"
-          bundle exec rdoc --root=ruby --include=ruby/doc --main=README.md --template=rorvswild --debug
-          ls -l
+        run: bundle exec rake rdoc
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
 

diff --git a/.github/workflows/ruby-docs.yml b/.github/workflows/ruby-docs.yml
@@ -0,0 +1,59 @@
+name: Deploy Ruby docs to Pages
+
+on:
+  push:
+    branches: [ 'ruby-docs' ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    if: ${{ github.repository == 'basesecrete/rdoc' && !startsWith(github.event_name, 'pull') }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Checkout Ruby
+        uses: actions/checkout@v4
+        with:
+          repository: ruby/ruby
+          path: ruby
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@161cd54b698f1fb3ea539faab2e036d409550e3c # v1.187.0
+        with:
+          ruby-version: '3.2'
+          bundler-cache: true
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+
+      - name: Build with RDoc
+        run: |
+          bundle
+          bundle exec rake generate
+          bundle exec rdoc --root=ruby --include=ruby/doc --main=README.md --template=rorvswild --debug
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4