From 42b499b33d6b4257bfa60725ac51053e504f93df Mon Sep 17 00:00:00 2001
From: "Adam M. Krajewski" <54290107+amkrajewski@users.noreply.github.com>
Date: Thu, 26 Dec 2024 00:30:05 +0000
Subject: [PATCH] - switched to `macos` for documentation building, retaining
`ubuntu` for deployment to GitHub pages
---
.github/workflows/generateDocumentation.yaml | 53 ++++++++++++--------
1 file changed, 32 insertions(+), 21 deletions(-)
diff --git a/.github/workflows/generateDocumentation.yaml b/.github/workflows/generateDocumentation.yaml
index d13fdf0..30f898d 100644
--- a/.github/workflows/generateDocumentation.yaml
+++ b/.github/workflows/generateDocumentation.yaml
@@ -13,41 +13,52 @@ permissions:
jobs:
generateDocumentation:
- environment:
- name: github-pages
- url: ${{ steps.deployment.outputs.page_url }}
- runs-on: ubuntu-latest
+ runs-on: macos-15
steps:
- name: Checkout
uses: actions/checkout@v4
- - name: Install BLAS and PCRE
- run: sudo apt-get install -y libopenblas-dev libpcre3-dev
- - uses: jiro4989/setup-nim-action@v2
- with:
- nim-version: '2.0.2'
- repo-token: ${{ secrets.GITHUB_TOKEN }}
- - run: nimble refresh
- - run: nimble install
- - run: nimble install arraymancer@0.7.30
- - run: nimble install nimcuda@0.1.9
+ - name: Install Nim with Homebrew
+ run: brew install nim
+ - name: Install nimplex and dependencies
+ run: nimble install
- name: Build documentation
run: |
cd docs
nim c -r -d:ssl -d:changelogType=nim -d:user=amkrajewski -d:repo=nimplex getChangelog
cd ..
- sed -i 's/assets/nimplex\/assets/g' docs/docs.nim
- sed -i 's/assets/nimplex\/assets/g' nimplex.nim
+ sed -i '' 's/assets/nimplex\/assets/g' docs/docs.nim
+ sed -i '' 's/assets/nimplex\/assets/g' nimplex.nim
nim doc --outdir:docs --index:on --git.url:https://github.com/amkrajewski/nimplex --git.commit:main --docInternal --project nimplex.nim
- sed -i '26i' docs/nimplex.html
- sed -i '12d' docs/nimplex.html
- sed -i '12d' docs/nimplex.html
- sed -i '12i' docs/nimplex.html
+ sed -i '' '26i\
+ ' docs/nimplex.html
+ sed -i '' '12d' docs/nimplex.html
+ sed -i '' '12d' docs/nimplex.html
+ sed -i '' '12i\
+ ' docs/nimplex.html
cp docs/nimplex.html docs/index.html
- name: Copy assets to docs
run: cp -r assets docs/assets
+ - name: Upload artifact
+ uses: actions/upload-artifact@v4
+ with:
+ name: documentation
+ path: docs/
+
+ deploy:
+ needs: generateDocumentation
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
+ runs-on: ubuntu-latest
+ steps:
+ - name: Download artifact
+ uses: actions/download-artifact@v4
+ with:
+ name: documentation
+ path: docs/
- name: Setup Pages
uses: actions/configure-pages@v4
- - name: Upload artifact
+ - name: Upload pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: 'docs'