-
Notifications
You must be signed in to change notification settings - Fork 696
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create security policy, publish script for lts
Resolves #1857
- Loading branch information
Showing
3 changed files
with
61 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Security Policy | ||
|
||
## Supported Versions | ||
|
||
The TypeDoc team supports the latest minor version. For one minor version prior to the latest, | ||
pull requests providing patches to fix security vulnerabilities will be accepted. Support for the | ||
previous minor version relies completely on community pull requests. | ||
|
||
| Version | Status | | ||
| ------- | ------------------ | | ||
| 0.22.x | :white_check_mark: | | ||
| 0.21.x | :warning: | | ||
| < 0.21 | :x: | | ||
|
||
## Patching LTS Versions | ||
|
||
If you depend on the prior minor version of TypeDoc and want to submit a fix, submit a pull request | ||
to the `lts` branch. When merged, a new version will be automatically published with your patch. | ||
|
||
Be sure to include: | ||
|
||
- A line in `CHANGELOG.md` that notes what changed. | ||
- An update to the version field in `package.json`. | ||
|
||
Note: Only pull requests which fix security vulnerabilities will be accepted. Additional features and bug fixes are out of scope for old versions. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
name: Publish LTS | ||
on: | ||
push: | ||
branches: | ||
- lts | ||
jobs: | ||
npm-publish: | ||
name: npm-publish | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v2 | ||
- id: check | ||
uses: EndBug/version-check@v1 | ||
with: | ||
diff-search: true | ||
- name: Set up Node | ||
if: steps.check.outputs.changed == 'true' | ||
uses: actions/setup-node@v1 | ||
with: | ||
node-version: "16" | ||
- name: Upgrade npm | ||
if: steps.check.outputs.changed == 'true' | ||
run: npm i -g npm@latest | ||
- name: Install | ||
if: steps.check.outputs.changed == 'true' | ||
run: npm ci | ||
- name: Setup publish token | ||
if: steps.check.outputs.changed == 'true' | ||
run: echo "//registry.npmjs.org/:_authToken=${NPM_AUTH_TOKEN}" > .npmrc | ||
env: | ||
NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }} | ||
- name: Publish | ||
if: steps.check.outputs.changed == 'true' | ||
run: npm publish --tag lts |