Slides for FCS Endpoint Development (#3)

.github/workflows/build-fcs-endpoint-dev-slides-adoc.yml

@@ -0,0 +1,52 @@
+name: build <fcs-endpoint-dev-slides> adocs slides
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+      - fcs-endpoint-dev-slides
+    paths:
+      - 'fcs-endpoint-dev-slides/**'
+      - '.github/workflows/build-fcs-endpoint-dev-slides-adoc.yml'
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    container: asciidoctor/docker-asciidoctor
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup reveal.js
+        run: |
+          git clone -b 4.1.2 --depth 1 https://github.com/hakimel/reveal.js.git
+          mkdir -p slides/reveal.js
+          mv reveal.js/dist slides/reveal.js/
+          mv reveal.js/plugin slides/reveal.js/
+
+      - name: Setup highlight.js for reveal.js
+        run: |
+          git clone -b 10.7.3 --depth 1 https://github.com/highlightjs/highlight.js.git
+          cp highlight.js/src/styles/github.css slides/reveal.js/plugin/highlight/
+          cp highlight.js/src/styles/idea.css slides/reveal.js/plugin/highlight/
+          cp highlight.js/src/styles/magula.css slides/reveal.js/plugin/highlight/
+
+      - name: Build slides
+        run: asciidoctor-revealjs -v -D slides fcs-endpoint-dev-slides/index.adoc
+
+      - name: Copy slide resources
+        run: |
+          mv -v fcs-endpoint-dev-slides/images slides/
+          mv -v fcs-endpoint-dev-slides/css slides/
+
+      - name: Store results
+        uses: actions/upload-artifact@v4
+        with:
+          name: fcs-endpoint-dev-slides
+          path: slides/*

.github/workflows/cleanup.yml

@@ -0,0 +1,65 @@
+name: Delete old workflow runs
+on:
+  workflow_dispatch:
+    inputs:
+      days:
+        description: 'Days-worth of runs to keep for each workflow'
+        required: true
+        default: '30'
+      minimum_runs:
+        description: 'Minimum runs to keep for each workflow'
+        required: true
+        default: '6'
+      delete_workflow_pattern:
+        description: 'Name or filename of the workflow (if not set, all workflows are targeted)'
+        required: false
+      delete_workflow_by_state_pattern:
+        description: 'Filter workflows by state: active, deleted, disabled_fork, disabled_inactivity, disabled_manually'
+        required: true
+        default: "ALL"
+        type: choice
+        options:
+          - "ALL"
+          - active
+          - deleted
+          - disabled_inactivity
+          - disabled_manually
+      delete_run_by_conclusion_pattern:
+        description: 'Remove runs based on conclusion: action_required, cancelled, failure, skipped, success'
+        required: true
+        default: "ALL"
+        type: choice
+        options:
+          - "ALL"
+          - "Unsuccessful: action_required,cancelled,failure,skipped"
+          - action_required
+          - cancelled
+          - failure
+          - skipped
+          - success
+      dry_run:
+        description: 'Logs simulated changes, no deletions are performed'
+        required: false
+
+jobs:
+  del_runs:
+    runs-on: ubuntu-latest
+    permissions:
+      actions: write
+    steps:
+      - name: Delete workflow runs
+        uses: Mattraks/delete-workflow-runs@v2
+        with:
+          token: ${{ github.token }}
+          repository: ${{ github.repository }}
+          retain_days: ${{ github.event.inputs.days }}
+          keep_minimum_runs: ${{ github.event.inputs.minimum_runs }}
+          delete_workflow_pattern: ${{ github.event.inputs.delete_workflow_pattern }}
+          delete_workflow_by_state_pattern: ${{ github.event.inputs.delete_workflow_by_state_pattern }}
+          delete_run_by_conclusion_pattern: >-
+            ${{
+              startsWith(github.event.inputs.delete_run_by_conclusion_pattern, 'Unsuccessful:')
+              && 'action_required,cancelled,failure,skipped'
+              || github.event.inputs.delete_run_by_conclusion_pattern
+            }}
+          dry_run: ${{ github.event.inputs.dry_run }}

README.md

@@ -63,7 +63,41 @@ docker run --rm -it -v $(pwd):/documents asciidoctor/docker-asciidoctor
 
 * [CLARIN Federated Content Search - FCS **Endpoint Developer's Tutorial**: `fcs-endpoint-dev-tutorial/index.adoc`](fcs-endpoint-dev-tutorial/index.adoc)
 
-For build instructions, see section [Specification Documents "How to build"](#how-to-build).
+  For build instructions, see section [Specification Documents "How to build"](#how-to-build).
+
+* [CLARIN Federated Content Search - FCS **Endpoint Development** Slides: `fcs-endpoint-dev-slides`](fcs-endpoint-dev-slides/index.adoc)
+
+  This is a RevealJS slide deck based on AsciiDoc and needs slightly different build steps. Those are currently only listed in the [GitHub Actions Workflow](.github/workflows/build-fcs-endpoint-dev-slides-adoc.yml). The following are a copy:
+
+  ```bash
+  # Output will be placed in `slides/`
+
+  # Setup "dependencies"
+  git clone -b 4.1.2 --depth 1 https://github.com/hakimel/reveal.js.git
+  mkdir -p slides/reveal.js
+  mv reveal.js/dist slides/reveal.js/
+  mv reveal.js/plugin slides/reveal.js/
+  rm -rf reveal.js/
+
+  git clone -b 10.7.3 --depth 1 https://github.com/highlightjs/highlight.js.git
+  mv highlight.js/src/styles/github.css slides/reveal.js/plugin/highlight/
+  mv highlight.js/src/styles/idea.css slides/reveal.js/plugin/highlight/
+  mv highlight.js/src/styles/magula.css slides/reveal.js/plugin/highlight/
+  rm -rf highlight.js/
+
+  # Build Slides
+  asciidoctor-revealjs -v -D slides fcs-endpoint-dev-slides/index.adoc
+
+  # Copy images/styles/...
+  cp -R -v fcs-endpoint-dev-slides/images slides/
+  cp -R -v fcs-endpoint-dev-slides/css slides/
+  cp -R -v fcs-endpoint-dev-slides/js slides/
+
+  # Display slides, visit "localhost:8000"
+  cd slides/
+  python3 -m http.server 8000
+  # or simply open the "index.html"
+  ```
 
 ## Historical Resources