Skip to content

Commit 145a7c3

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 eadd0f4 commit 145a7c3

File tree

1 file changed

+83
-0
lines changed

1 file changed

+83
-0
lines changed

.github/workflows/publish_docs.yml

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
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+
jobs:
20+
build:
21+
runs-on: ubuntu-24.04
22+
permissions:
23+
contents: read
24+
pull-requests: write
25+
26+
steps:
27+
- name: "Install deps"
28+
run: |
29+
sudo apt install -y make git
30+
31+
- uses: erlef/setup-beam@v1
32+
with:
33+
otp-version: "28"
34+
35+
- name: "Build rebar3"
36+
run: |
37+
cd /tmp
38+
git clone https://github.com/erlang/rebar3.git
39+
cd rebar3
40+
./bootstrap
41+
42+
- name: "Checkout code"
43+
uses: actions/checkout@v4
44+
with:
45+
repository: ${{ vars.GITHUB_REPOSITORY }}
46+
fetch-depth: 0
47+
48+
- name: "Setup Pages"
49+
uses: actions/configure-pages@v5
50+
51+
- name: "Build Docs"
52+
if: github.repository == 'atomvm/atomvm_packbeam'
53+
run: |
54+
PATH="/tmp/rebar3:${PATH}" make doc
55+
56+
- name: Upload docs artifact
57+
uses: actions/upload-artifact@v4
58+
with:
59+
name: atomvm_packbeam-docs
60+
path: ./docs
61+
if-no-files-found: error
62+
63+
deploy:
64+
# Add a dependency to the build job
65+
needs: build
66+
67+
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
68+
permissions:
69+
pages: write # to deploy to Pages
70+
id-token: write # to verify the deployment originates from an appropriate source
71+
72+
# Deploy to the github-pages environment
73+
environment:
74+
name: github-pages
75+
url: ${{ steps.deployment.outputs.page_url }}
76+
77+
# Specify runner + deployment step
78+
runs-on: ubuntu-latest
79+
steps:
80+
- name: Deploy to GitHub Pages
81+
if: ${{ github.repository == 'atomvm/atomvm_packbeam' }}
82+
id: deployment
83+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)