Skip to main content

Github Actions

For who​

This article is for maintainers, but also users who'd like to know what actions get triggered by what type of events.

Results: insight in the choice around our Coninuous Development Continuous Integration (CDCI) process.

Github Actions are readible for most people who are able to read pseudo-code. The structure and organization of our Action scripts and those brought in by third party tools like Docusaurus, can be distilled fom the source code. However, we 'd like to offer a convenient insight in the structure and working.

Description​

  • script are set off by hand or automatic? Or both? In which situation would you apply these options.
  • are certain Action scripts calling eachtother? If so it needs to be clear under what circumstances.

There are currently five Github Actions. All actions should be started manually. One script is started via Cron: the “Find broken links” action. No actions are triggered by Push commits.

This means that after updating the Wiki, you should run the “Import wiki” action manually to get the new content into this repo. If you wish to publish the new content to the website, you should run “Deploy to Github Pages”.

The same goes for importing external glossaries and importing metadata.

  1. Deploy to Github Pages:
    • runs on workflow_dispatch (manual start)
    • receives changes that are pushed (content updates, e.g. HowTo's, or design updates)
    • builds and copies /build to gh-pages
  2. Find broken links:
    • runs on cron and workflow_dispatch (manual start)
    • checks links
    • creates issue
  3. Import external glossaries:
    • runs on workflow_dispatch (manual start)
    • updates external glossaries
    • pushes updates into repo
  4. Import meta data from google sheets:
    • runs on workflow_dispatch (manual start)
    • updates meta data from google sheet
    • pushes updates into repo
  5. Import wiki:
    • runs on workflow_dispatch (manual start)
    • copies wiki to /docs/glossary
    • pushes changes into repo
  6. Scraper: To Be Created
    • runs on workflow_dispatch:
    • scrapes various sources
    • imports result into Typesense, makes backup, etc
    • pushes updates into repo