Merge branch 'master' into dev
This commit is contained in:
ThinLiquid
GitHub
commit
fbd7d205fc
5 changed files with 6448 additions and 55 deletions
34
.github/workflows/release.yml
vendored
Normal file
34
.github/workflows/release.yml
vendored
Normal file
|
|
@ -0,0 +1,34 @@
|
||||||
|
name: Release
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [master]
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read # for checkout
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
release:
|
||||||
|
name: Release
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: write # to be able to publish a GitHub release
|
||||||
|
issues: write # to be able to comment on released issues
|
||||||
|
pull-requests: write # to be able to comment on released pull requests
|
||||||
|
id-token: write # to enable use of OIDC for npm provenance
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
- name: Setup Node.js
|
||||||
|
uses: actions/setup-node@v3
|
||||||
|
with:
|
||||||
|
node-version: "lts/*"
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npm clean-install
|
||||||
|
- name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
|
||||||
|
run: npm audit signatures
|
||||||
|
- name: Release
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
run: npx semantic-release
|
||||||
8
.releaserc
Normal file
8
.releaserc
Normal file
|
|
@ -0,0 +1,8 @@
|
||||||
|
{
|
||||||
|
"branches": ["master"],
|
||||||
|
"plugins": [
|
||||||
|
"@semantic-release/commit-analyzer",
|
||||||
|
"@semantic-release/release-notes-generator",
|
||||||
|
"@semantic-release/github"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
@ -16,62 +16,39 @@ Please note we have a code of conduct, please follow it in all your interactions
|
||||||
|
|
||||||
## Commit Guidelines
|
## Commit Guidelines
|
||||||
|
|
||||||
| Commit type | Emoji |
|
All commits made should follow the [Semantic Release](https://github.com/semantic-release/semantic-release#commit-message-format) commit message format.
|
||||||
|:----------------------------|:----------------------------------------------------------|
|
|
||||||
| Version tag | :bookmark: `:bookmark:` |
|
|
||||||
| New feature | :sparkles: `:sparkles:` |
|
|
||||||
| Bugfix | :bug: `:bug:` |
|
|
||||||
| Metadata | :card_index: `:card_index:` |
|
|
||||||
| Documentation | :books: `:books:` |
|
|
||||||
| Documenting source code | :bulb: `:bulb:` |
|
|
||||||
| Performance | :racehorse: `:racehorse:` |
|
|
||||||
| Cosmetic | :lipstick: `:lipstick:` |
|
|
||||||
| Tests | :rotating_light: `:rotating_light:` |
|
|
||||||
| Adding a test | :white_check_mark: `:white_check_mark:` |
|
|
||||||
| Make a test pass | :heavy_check_mark: `:heavy_check_mark:` |
|
|
||||||
| General update | :zap: `:zap:` |
|
|
||||||
| Improve format/structure | :art: `:art:` |
|
|
||||||
| Refactor code | :hammer: `:hammer:` |
|
|
||||||
| Removing code/files | :fire: `:fire:` |
|
|
||||||
| Continuous Integration | :green_heart: `:green_heart:` |
|
|
||||||
| Security | :lock: `:lock:` |
|
|
||||||
| Upgrading dependencies | :arrow_up: `:arrow_up:` |
|
|
||||||
| Downgrading dependencies | :arrow_down: `:arrow_down:` |
|
|
||||||
| Lint | :shirt: `:shirt:` |
|
|
||||||
| Translation | :alien: `:alien:` |
|
|
||||||
| Text | :pencil: `:pencil:` |
|
|
||||||
| Critical hotfix | :ambulance: `:ambulance:` |
|
|
||||||
| Deploying stuff | :rocket: `:rocket:` |
|
|
||||||
| Work in progress | :construction: `:construction:` |
|
|
||||||
| Adding CI build system | :construction_worker: `:construction_worker:` |
|
|
||||||
| Analytics or tracking code | :chart_with_upwards_trend: `:chart_with_upwards_trend:` |
|
|
||||||
| Removing a dependency | :heavy_minus_sign: `:heavy_minus_sign:` |
|
|
||||||
| Adding a dependency | :heavy_plus_sign: `:heavy_plus_sign:` |
|
|
||||||
| Docker | :whale: `:whale:` |
|
|
||||||
| Configuration files | :wrench: `:wrench:` |
|
|
||||||
| NodeJS package.json | :package: `:package:` |
|
|
||||||
| Merging branches | :twisted_rightwards_arrows: `:twisted_rightwards_arrows:` |
|
|
||||||
| Bad code / need improv. | :hankey: `:hankey:` |
|
|
||||||
| Reverting changes | :rewind: `:rewind:` |
|
|
||||||
| Breaking changes | :boom: `:boom:` |
|
|
||||||
| Code review changes | :ok_hand: `:ok_hand:` |
|
|
||||||
| Accessibility | :wheelchair: `:wheelchair:` |
|
|
||||||
| Move/rename repository | :truck: `:truck:` |
|
|
||||||
| Issue/Pull Request template | :newspaper_roll: `:newspaper_roll:` |
|
|
||||||
| Merge pull request | :knot: `:knot:` |
|
|
||||||
| Assets | :bento: `:bento:` |
|
|
||||||
|
|
||||||
### Format
|
## Pull Request Guidelines
|
||||||
|
|
||||||
Your commit messages should use the following as a guide:
|
A PR should be named using the following anatomy:
|
||||||
```
|
|
||||||
[emoji] description
|
|
||||||
```
|
|
||||||
|
|
||||||
This is an example of this being used for "**Assets**":
|
`[emoji]` `(#issue)` `summary`
|
||||||
```
|
|
||||||
[🍱] Added terminal.png
|
As an example: `[➕] (#126) cool thing added`
|
||||||
```
|
|
||||||
|
### emoji
|
||||||
|
|
||||||
|
The emoji should be the first thing in the name, to let everyone know what kind of change the PR is putting forward. Here is a table of the standard emojis, and why they should be used.
|
||||||
|
|
||||||
|
| Emoji | Keyword | Meaning |
|
||||||
|
|-----------------------------------------|------------|--------------------------------------------------------|
|
||||||
|
| :heavy_plus_sign: `:heavy_plus_sign:` | `add` | Create a capability e.g. feature, test, dependency. |
|
||||||
|
| :heavy_minus_sign: `:heavy_minus_sign:` | `remove` | Remove a capability e.g. feature, test, dependency. |
|
||||||
|
| :hammer: `:hammer:` | `refactor` | An update to existing code and/or refactoring. |
|
||||||
|
| :bug: `:bug:` | `fix` | Fix an issue e.g. bug, typo, accident, misstatement. |
|
||||||
|
| :up: `:up:` | `bump` | Increase the version of something e.g. dependency. |
|
||||||
|
| :bricks: `:bricks:` | `build` | Change *only* to the build process, tooling, or infra. |
|
||||||
|
| :memo: `:memo:` | `docs` | A change to documentation *only*. |
|
||||||
|
| :arrow_right_hook: `:arrow_right_hook:` | `revert` | Reverting a previous commit. |
|
||||||
|
| :knot: `:knot:` | `merge` | Merging a branch into another. |
|
||||||
|
|
||||||
|
### issue
|
||||||
|
|
||||||
|
Following the emoji is the issue number - this is the issue the PR addresses. It is formatted as `(#XXX)` where XXX is the GitHub issue number.
|
||||||
|
|
||||||
|
### summary
|
||||||
|
|
||||||
|
This is a short summary of what your commit is doing.
|
||||||
|
|
||||||
## Code of Conduct
|
## Code of Conduct
|
||||||
|
|
||||||
|
|
|
||||||
6368
package-lock.json
generated
6368
package-lock.json
generated
File diff suppressed because it is too large
Load diff
10
package.json
10
package.json
|
|
@ -9,7 +9,8 @@
|
||||||
"dev": "vite",
|
"dev": "vite",
|
||||||
"build": "vite build",
|
"build": "vite build",
|
||||||
"preview": "vite preview",
|
"preview": "vite preview",
|
||||||
"serve": "vite dev"
|
"serve": "vite dev",
|
||||||
|
"commit": "cz"
|
||||||
},
|
},
|
||||||
"keywords": [],
|
"keywords": [],
|
||||||
"author": "",
|
"author": "",
|
||||||
|
|
@ -18,7 +19,9 @@
|
||||||
"@types/node": "^20.11.3",
|
"@types/node": "^20.11.3",
|
||||||
"@types/uuid": "^9.0.5",
|
"@types/uuid": "^9.0.5",
|
||||||
"@types/web": "^0.0.117",
|
"@types/web": "^0.0.117",
|
||||||
|
"commitizen": "^4.3.0",
|
||||||
"less": "^4.2.0",
|
"less": "^4.2.0",
|
||||||
|
"semantic-release": "^23.0.0",
|
||||||
"ts-standard": "^12.0.2",
|
"ts-standard": "^12.0.2",
|
||||||
"typedoc": "^0.25.3",
|
"typedoc": "^0.25.3",
|
||||||
"typedoc-material-theme": "^1.0.2",
|
"typedoc-material-theme": "^1.0.2",
|
||||||
|
|
@ -41,5 +44,10 @@
|
||||||
"ignore": [
|
"ignore": [
|
||||||
"public"
|
"public"
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
"config": {
|
||||||
|
"commitizen": {
|
||||||
|
"path": "./node_modules/cz-conventional-changelog"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue