WIP

Author: CMCDragonkai

.github/workflows/app-build.yml

@@ -8,4 +8,84 @@ GitLab templates are stored in `.gitlab`. This repository must be selected as th
 
 Note that template syntax differs by a little bit. In particular GitHub templates require a stanza at the beginning while GitLab templates use special slash commands. When updating the templates for GitHub or GitLab, ensure that it is also updated for the other system as well so we can have a consistent set of templates.
 
-Ensure that this repository is mirrored from GitLab to GitHub.
+Ensure that this repository is mirrored from GitLab to GitHub.
+
+## Workflows
+
+This is where we centralized re-usable workflows for GitHub actions. Workflows
+are grouped together into different kinds of projects.
+
+* library-js - TS/JS projects that produce libraries as NPM packages.
+  - feature - for feature branches
+  - staging - for staging branches
+  - tag - for tag branches
+
+To use them, for example in a library-js project. You create 3 caller workflows
+in `/.github/workflows`:
+
+* `feature.yml`
+  ```yml
+  name: "CI / Feature"
+
+  on:
+  push:
+      branches:
+      - feature*
+  workflow_dispatch:
+
+  concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+  jobs:
+  use-library-js-feature:
+      permissions:
+      packages: read
+      contents: read
+      actions: write
+      checks: write
+      uses: MatrixAI/.github/.github/workflows/library-js-feature.yml@master
+  ```
+* `staging.yml`
+  ```yml
+  name: "CI / Staging"
+  
+  on:
+    push:
+      branches:
+        - staging
+    workflow_dispatch:
+  
+  concurrency:
+    group: ${{ github.workflow }}-${{ github.ref }}
+    cancel-in-progress: true
+  
+  jobs:
+    use-library-js-staging:
+      permissions:
+        packages: read
+        contents: read
+        actions: write
+        checks: write
+        pull-requests: write
+      uses: MatrixAI/.github/.github/workflows/library-js-staging.yml@master
+  
+  ```
+* `tag.yml`
+  ```yml
+  name: "CI / Tag"
+  
+  on:
+    push:
+      tags:
+        - 'v*.*.*'
+    workflow_dispatch:
+  
+  jobs:
+    use-library-js-tag:
+      permissions:
+        packages: read
+        contents: read
+        actions: write
+      uses: MatrixAI/.github/.github/workflows/library-js-tag.yml@master
+  ```