https://github.com/matrixai/.github
Templates for Matrix AI
https://github.com/matrixai/.github
Last synced: 4 months ago
JSON representation
Templates for Matrix AI
- Host: GitHub
- URL: https://github.com/matrixai/.github
- Owner: MatrixAI
- Created: 2021-07-05T00:54:43.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-06T02:16:21.000Z (10 months ago)
- Last Synced: 2025-03-06T03:24:14.137Z (10 months ago)
- Homepage: https://matrix.ai
- Size: 86.9 KB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Templates
## Issues, Pull Requests, Merge Requests
This repository stories issue, pull request and merge request templates for Matrix AI
GitHub templates are stored in `.github`. This repository must be placed under https://github.com/MatrixAI/.github. The `.github` repository name is essential for GitHub to recognise it as a special organisation-template repository.
GitLab templates are stored in `.gitlab`. This repository must be selected as the templates repository under `Settings > General > Templates`.
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.
## 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
* library-js-native - TS/JS projects that produce libraries using native code as NPM packages.
- feature
- staging
- tag
* application-js-cloudflare - TS/JS projects that produce Cloudflare applications
- feature
- staging
- master
- feature-closed
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:
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:
contents: read
actions: write
checks: write
pull-requests: write
uses: MatrixAI/.github/.github/workflows/library-js-staging.yml@master
secrets: inherit
```
* `tag.yml`
```yml
name: "CI / Tag"
on:
push:
tags:
- 'v*.*.*'
workflow_dispatch:
jobs:
use-library-js-tag:
permissions:
contents: read
actions: write
uses: MatrixAI/.github/.github/workflows/library-js-tag.yml@master
secrets: inherit
```