Home

Welcome to the architecture-and-reference-framework wiki!

Actions - Notes and Examples

Build the ARF and attach it as an Artifact

In the future this action will attache the artifact to the release

# Simple workflow for deploying static content to GitHub Pages
name: Deploy ARF to Pages

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["main"]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  # Single deploy job since we're just deploying
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Install pandoc
        run: sudo apt install -y pandoc
      - name: Install dependencies
        run: make prepare
      - name: Build
        run: make
      - name: Setup Pages
        uses: actions/configure-pages@v3
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          # Upload entire repository
          path: dist
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v1

Build and deploy the ARF in Pages

# Simple workflow for deploying static content to GitHub Pages
name: Deploy ARF to Pages

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["main"]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  # Single deploy job since we're just deploying
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Install pandoc
        run: sudo apt install -y pandoc
      - name: Install dependencies
        run: make prepare
      - name: Build
        run: make
      - name: Setup Pages
        uses: actions/configure-pages@v3
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          # Upload entire repository
          path: dist
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v1

Download the artifact

jobs:
  # As per: https://docs.github.com/en/actions/using-workflows/storing-workflow-data-as-artifacts
  page:
    name: Download artifact
    needs: build
    runs-on: ubuntu-latest
    steps:
      - name: Download ARF
        uses: actions/download-artifact@v3
#         with:
#           name: arf-build--${{ env.date }}
      - name: Print the final result
        shell: bash
        run: |
          ls -la
          ls ./arf-build
          value=`cat ./arf-build/arf.html`
          echo The result is $value

It complements the Build action