Skip to content

Commit

Permalink
Merge remote-tracking branch 'WebFreak001/master'
Browse files Browse the repository at this point in the history
  • Loading branch information
chenzhiy2001 committed Jan 16, 2024
2 parents 4982e91 + 7ee97b6 commit 9b9d162
Show file tree
Hide file tree
Showing 25 changed files with 2,459 additions and 200 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/changelog_audit.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Changelog Audit
on:
push:
paths:
- ./CHANGELOG.md
pull_request:
paths:
- ./CHANGELOG.md
jobs:
# Linting, stylechecking and spellchecking are covered by the general document
# linting job, so this only checks that the changelog is conformant with the
# "Keep a Changelog" format.
changelog_audit:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Validate Changelog
uses: mindsers/changelog-reader-action@v2
with:
validation_level: error
path: ./CHANGELOG.md
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
node-version: 16.x

- name: Install Module Dependencies
run: npm clean-install --no-optional
run: npm clean-install --omit=optional

- name: Lint Project
run: npm run lint
8 changes: 7 additions & 1 deletion .github/workflows/lint_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,13 @@ jobs:
node-version: 16.x

- name: Install Module Dependencies
run: npm clean-install --no-optional
run: npm clean-install --omit=optional

- name: Stylecheck Project Documentation
run: npm run prettier-check-docs

- name: Lint Project Documentation
run: npm run lint-docs

- name: Lint Documentation Links
run: npm run link-check
6 changes: 3 additions & 3 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ jobs:
- name: Query Latest Changelog Version
id: changelog
shell: bash
run: echo ::set-output name=version::$(grep --perl-regexp "^# " --max-count=1 CHANGELOG.md | awk '{print $2}')
run: echo ::set-output name=version::$(grep --perl-regexp "^## " --max-count=1 CHANGELOG.md | tr --delete [] | awk '{print $2}')

- name: Audit package.json/package-lock.json/CHANGELOG.md/git tag Version Consistency
shell: bash
Expand All @@ -55,12 +55,12 @@ jobs:
# be released.
#
# NOTE:
# Use the `--no-optional` switch to prevent installation of the `ssh2` optional dependency
# Use the `--omit=optional` switch to prevent installation of the `ssh2` optional dependency
# (i.e., `cpu-features`) package which is used to provide accelerated crypto functionality,
# but which is a native add-on and would require platform specific packages.
#
- name: Install Module Dependencies
run: npm clean-install --no-optional
run: npm clean-install --omit=optional

#
# Package and Upload Extension
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/unit_test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
node-version: 16.x

- name: Install Module Dependencies
run: npm clean-install --no-optional
run: npm clean-install --omit=optional

- name: Test Project
run: npm test
Expand Down
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ node_modules
riscv64-unknown-elf-toolchain-10.2.0-2020.12.8-x86_64-linux-ubuntu14.tar.gz
.nyc_output
.vscode-test
package-lock.json
package-lock.json
.secrets
1 change: 0 additions & 1 deletion .markdownlintignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Temporarily ignored until they can be updated to abide by the lint rules.
CHANGELOG.md
README.md

# Don't lint markdown belonging to dependency modules.
Expand Down
1 change: 0 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Temporarily ignored until they can be updated to abide by the style rules.
CHANGELOG.md
README.md

**/.github
Expand Down
8 changes: 8 additions & 0 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,14 @@
"args": ["run", "lint-docs"],
"problemMatcher": "$markdownlint"
},
{
"label": "npm:link-check",
"detail": "Link Check Project Documentation",
"type": "shell",
"command": "npm",
"group": "build",
"args": ["run", "link-check"]
},
{
"label": "npm:spellcheck-docs",
"detail": "Spellcheck Project Documentation",
Expand Down
4 changes: 4 additions & 0 deletions .vscodeignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# List of paths and files to exclude from the packaged extension.
.github/**
.nyc_output/**
.vscode/**
coverage/**
typings/**
node_modules/**/build
out/src/test/**
test/**
src/**
Expand All @@ -13,6 +16,7 @@ src/**
.nycrc.yml
.prettierignore
.prettierrc
.secrets
cspell.json
cspell-dict.txt
HACKING.md
Expand Down
Loading

0 comments on commit 9b9d162

Please sign in to comment.