Skip to content

Commit 9a8387c

Browse files
committed
Add workflow automation to publish docs
Automates the publication of documentation to github pages when changes are merged to the master branch. This will keep the github pages in sync with the master barnch and users can use the docs published to hex.pm for release versions. Signed-off-by: Winford <[email protected]>
1 parent b23cf0c commit 9a8387c

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

.github/workflows/publish_docs.yml

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
#
2+
# Copyright 2025 Winford (Uncle Grumpy) <[email protected]>
3+
#
4+
# SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later
5+
#
6+
# This is a workflow for atomvm/atomvm_packbeam to publish documentation to GitHub Pages
7+
8+
name: Publish Docs
9+
10+
on:
11+
# Triggers the workflow on tags
12+
push:
13+
branches:
14+
- 'master'
15+
16+
# Allows you to run this workflow manually from the Actions tab
17+
workflow_dispatch:
18+
19+
permissions:
20+
contents: read
21+
pages: write
22+
id-token: write
23+
24+
jobs:
25+
build:
26+
runs-on: ubuntu-24.04
27+
container: erlang:28
28+
29+
#steps:
30+
#- name: "Install deps"
31+
# run: |
32+
# sudo apt install -y make git
33+
34+
- name: "Checkout code"
35+
uses: actions/checkout@v4
36+
37+
- name: "Setup Pages"
38+
uses: actions/configure-pages@v5
39+
40+
- name: "Build Docs"
41+
run: |
42+
rebar3 as doc ex_doc
43+
44+
- name: Upload pages artifact
45+
## Must use v3 for now due to issue actions/deploy-pages#389
46+
uses: actions/upload-pages-artifact@v3
47+
with:
48+
name: github-pages
49+
path: ./docs
50+
51+
deploy:
52+
# Add a dependency to the build job
53+
needs: build
54+
55+
# Deploy to the github-pages environment
56+
environment:
57+
name: github-pages
58+
url: ${{ steps.deployment.outputs.page_url }}
59+
60+
# Specify runner + deployment step
61+
runs-on: ubuntu-24.04
62+
steps:
63+
64+
- name: "Setup Pages"
65+
uses: actions/configure-pages@v5
66+
67+
- name: Deploy to GitHub Pages
68+
if: ${{ github.repository == 'atomvm/atomvm_packbeam' }}
69+
id: deployment
70+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)