branch: elpa/casual
commit 9c6bb466bf157fc7dca183cfbaaa4c8e6f745954
Merge: dfc74579bd c2ebd3cb3b
Author: Charles Choi <[email protected]>
Commit: GitHub <[email protected]>
Merge pull request #269 from kickingvegas/cc/publish-user-guide-action
Configure GitHub action deploy Casual User Guide.
---
.github/workflows/basic.yml | 13 +++++++------
.github/workflows/pages.yml | 33 +++++++++++++++++----------------
Makefile | 4 ++++
3 files changed, 28 insertions(+), 22 deletions(-)
diff --git a/.github/workflows/basic.yml b/.github/workflows/basic.yml
index 20b1349e98..77973a3dea 100644
--- a/.github/workflows/basic.yml
+++ b/.github/workflows/basic.yml
@@ -5,10 +5,10 @@ name: CI
# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request events but only for the
"main" branch
- push:
- branches: [ "development" ]
- pull_request:
- branches: [ "development" ]
+ # push:
+ # branches: [ "development", "cc/publish-user-guide-action"]
+ # pull_request:
+ # branches: [ "development" ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
@@ -32,5 +32,6 @@ jobs:
# Runs a set of commands using the runners shell
- name: Run a multi-line script
run: |
- echo Add other actions to build,
- echo test, and deploy your project.
+ echo Generating Casual User Guide
+ make -C docs gen-html
+
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
index 6729723d46..45f8d14deb 100644
--- a/.github/workflows/pages.yml
+++ b/.github/workflows/pages.yml
@@ -4,7 +4,7 @@ name: Deploy Casual User Guide to GitHub Pages
on:
# Runs on pushes targeting the default branch
push:
- branches: ["development"]
+ branches: ["main"]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
@@ -29,18 +29,19 @@ jobs:
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- # - name: Checkout
- # uses: actions/checkout@v4
- # - name: Setup Pages
- # uses: actions/configure-pages@v5
- - name: Hello world
- run: echo Hello world!
-
- # - name: Upload artifact
- # uses: actions/upload-pages-artifact@v3
- # with:
- # # Upload entire repository
- # path: './docs/html'
- # - name: Deploy to GitHub Pages
- # id: deployment
- # uses: actions/deploy-pages@v4
+ - name: Checkout
+ uses: actions/checkout@v4
+ - name: Setup Pages
+ uses: actions/configure-pages@v5
+ - name: Generate Casual User Guide
+ run: |
+ echo Generating Casual User Guide
+ make -C docs gen-html
+ - name: Upload artifact
+ uses: actions/upload-pages-artifact@v3
+ with:
+ # Upload docs/html directory
+ path: './docs/html'
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/deploy-pages@v4
diff --git a/Makefile b/Makefile
index a109a1626f..ffe81b74b3 100644
--- a/Makefile
+++ b/Makefile
@@ -125,3 +125,7 @@ create-gh-release: create-release-tag
status:
git status
+
+.PHONY: user-guide
+user-guide:
+ $(MAKE) -C docs gen-html
