mirror of
https://github.com/4source/open-editors-obsidian-plugin.git
synced 2026-07-22 11:40:26 +00:00
Improved templates and CI/CD
This commit is contained in:
parent
ef9d5b422e
commit
8b17b20151
7 changed files with 950 additions and 632 deletions
2
.github/ISSUE_TEMPLATE/bug_report.yaml
vendored
2
.github/ISSUE_TEMPLATE/bug_report.yaml
vendored
|
|
@ -35,7 +35,7 @@ body:
|
|||
id: operating-system
|
||||
attributes:
|
||||
label: OS of your device
|
||||
description: What operating system is your device runnging
|
||||
description: What operating system is your device running
|
||||
placeholder: e.g. Win10
|
||||
validations:
|
||||
required: true
|
||||
|
|
|
|||
6
.github/ISSUE_TEMPLATE/config.yml
vendored
6
.github/ISSUE_TEMPLATE/config.yml
vendored
|
|
@ -1,11 +1,11 @@
|
|||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Community Support
|
||||
url: https://github.com/4Source/obsidian-plugin-template/discussions/new/choose
|
||||
url: https://github.com/4Source/open-editors-obsidian-plugin/discussions
|
||||
about: Please ask and answer questions here.
|
||||
- name: Documentation
|
||||
url: https://github.com/4Source/obsidian-plugin-template/wiki
|
||||
url: https://github.com/4Source/open-editors-obsidian-plugin/wiki
|
||||
about: Check out the documentation if you want to know what's possible.
|
||||
- name: Contributing
|
||||
url: https://github.com/4Source/obsidian-plugin-template/blob/master/.github/CONTRIBUTING.md
|
||||
url: https://github.com/4Source/open-editors-obsidian-plugin/blob/master/.github/CONTRIBUTING.md
|
||||
about: Overview of the contribution workflow
|
||||
|
|
|
|||
20
.github/pull_request_template.md
vendored
20
.github/pull_request_template.md
vendored
|
|
@ -5,10 +5,20 @@
|
|||
|
||||
## Related Issues
|
||||
Fixes # <!-- Issue number --->
|
||||
### Missing changes
|
||||
<!-- Describe the changes what are missing which are describe in the Issue but are not implemented by this pull request --->
|
||||
|
||||
## Tests
|
||||
### How has this been tested?
|
||||
**OS:** <!-- e.g. Win10 --->
|
||||
|
||||
**Obsidian Version:** <!-- e.g. v1.5.1 --->
|
||||
|
||||
<!-- Please describe the tests that you ran to verify your changes and if there was successful or not. --->
|
||||
|
||||
## Checklist before requesting a review
|
||||
- [ ] I have performed a self-review of my code
|
||||
- [ ] My code follows the style guidelines of this project
|
||||
- [ ] I have commented my code, particularly in hard-to-understand areas
|
||||
- [ ] I have made corresponding changes to the documentation
|
||||
- [ ] My code fixes the feature discussed in [Related Issues](#related-issues)
|
||||
- [<!-- x --> ] I have performed a self-review of my code
|
||||
- [<!-- x --> ] I have commented my code, particularly in hard-to-understand areas
|
||||
- [<!-- x --> ] I have made corresponding changes to the documentation
|
||||
- [<!-- x --> ] I have tested my changes in Obsidian and describte how I tested in [Tests](#tests)
|
||||
- [<!-- x --> ] My code fixes the feature discussed in [Related Issues](#related-issues) if not or not fully describe what is missing in [Missing changes](#missing-changes)
|
||||
|
|
|
|||
21
.github/workflows/ci.yml
vendored
21
.github/workflows/ci.yml
vendored
|
|
@ -6,11 +6,13 @@ on:
|
|||
- master
|
||||
paths:
|
||||
- 'src/**'
|
||||
- 'test/**'
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
paths:
|
||||
- 'src/**'
|
||||
- 'test/**'
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
|
|
@ -74,6 +76,25 @@ jobs:
|
|||
|
||||
- name: Run Build
|
||||
run: npm run build
|
||||
|
||||
audit:
|
||||
name: Security Audit
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Use Node.js 18.x
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: "18.x"
|
||||
|
||||
- name: Install Dependencies
|
||||
run: npm install
|
||||
|
||||
- name: Audit for vulnerabilities
|
||||
run: npm audit --audit-level=moderate
|
||||
|
||||
version:
|
||||
name: Version Bump
|
||||
|
|
|
|||
2
.github/workflows/manual_release.yml
vendored
2
.github/workflows/manual_release.yml
vendored
|
|
@ -1,4 +1,4 @@
|
|||
name: Manual Realease
|
||||
name: Manual Release
|
||||
on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
|
|
|
|||
1515
package-lock.json
generated
1515
package-lock.json
generated
File diff suppressed because it is too large
Load diff
16
package.json
16
package.json
|
|
@ -5,22 +5,24 @@
|
|||
"scripts": {
|
||||
"dev": "node esbuild.config.mjs",
|
||||
"build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
|
||||
"lint": "eslint .",
|
||||
"lint-fix": "eslint . --fix",
|
||||
"lint": "eslint . --config .eslintrc.release",
|
||||
"lint-fix": "eslint . --fix --config .eslintrc.release",
|
||||
"dev:lint": "eslint . --config .eslintrc.dev",
|
||||
"dev:lint-fix": "eslint . --fix --config .eslintrc.dev",
|
||||
"version": "node version-change.mjs",
|
||||
"test": "jest --silent"
|
||||
"test": "jest --silent",
|
||||
"dev:test": "jest --coverage"
|
||||
},
|
||||
"author": "4Source",
|
||||
"license": "MIT",
|
||||
"devDependencies": {
|
||||
"@stylistic/eslint-plugin": "^1.6.3",
|
||||
"@stylistic/eslint-plugin": "^3.1.0",
|
||||
"@types/jest": "^29.5.12",
|
||||
"@types/node": "^20.10.7",
|
||||
"@types/obsidian-typings": "npm:obsidian-typings@^1.0.3",
|
||||
"@typescript-eslint/eslint-plugin": "^7.1.0",
|
||||
"@typescript-eslint/parser": "^7.1.0",
|
||||
"builtin-modules": "3.3.0",
|
||||
"esbuild": "0.17.3",
|
||||
"esbuild": "^0.25.8",
|
||||
"eslint": "^8.57.0",
|
||||
"jest": "^29.7.0",
|
||||
"jest-environment-jsdom": "^29.7.0",
|
||||
|
|
@ -31,4 +33,4 @@
|
|||
"typescript": "4.7.4"
|
||||
},
|
||||
"version": "0.2.0"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue