Skip to content

Commit 2fde819

Browse files
committed
Initial gh-pages contriution
0 parents  commit 2fde819

File tree

79 files changed

+9353
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+9353
-0
lines changed
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: Blocking Bug Report
2+
description: File a report for a blocking bug, i.e., issues that can't be worked around.
3+
title: "[Blocker]: "
4+
type: "Bug"
5+
labels: ["critical"]
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Is there an existing issue for this?
10+
description: Please search to see if an issue already exists for the bug you encountered.
11+
options:
12+
- label: I have searched the existing issues
13+
required: true
14+
- type: textarea
15+
attributes:
16+
label: Unusable feature
17+
description: Which feature(s) of CMSIS-Toolbox becomes unusable due to this bug?
18+
validations:
19+
required: true
20+
- type: textarea
21+
attributes:
22+
label: Current Behavior
23+
description: A concise description of what you're experiencing.
24+
validations:
25+
required: true
26+
- type: textarea
27+
attributes:
28+
label: Expected Behavior
29+
description: A concise description of what you expected to happen.
30+
validations:
31+
required: true
32+
- type: textarea
33+
attributes:
34+
label: Steps To Reproduce
35+
description: Steps to reproduce the behavior.
36+
placeholder: |
37+
1. In this environment...
38+
1. With this config...
39+
1. Run '...'
40+
1. See error...
41+
validations:
42+
required: false
43+
- type: checkboxes
44+
attributes:
45+
label: Affected operating systems
46+
description: On which host os platforms does the bug occur?
47+
options:
48+
- label: all
49+
required: false
50+
- label: Windows amd64
51+
required: false
52+
- label: Linux amd64
53+
required: false
54+
- label: Linux arm64
55+
required: false
56+
- label: MacOS arm64
57+
required: false
58+
- type: textarea
59+
attributes:
60+
label: Environment
61+
description: Give more details about the affected operating system(s), e.g. distribution and version.
62+
placeholder: |
63+
- Ubuntu 22.04
64+
- Windows 10 Version 22H2 (Build ...)
65+
validations:
66+
required: false
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Bug Report
2+
description: Report a bug
3+
title: "[Bug]: "
4+
type: "Bug"
5+
projects: "github/21"
6+
labels: []
7+
assignees: []
8+
9+
body:
10+
- type: markdown
11+
attributes:
12+
value: "### Thank you for reporting a problem!"
13+
14+
- type: input
15+
id: summary
16+
attributes:
17+
label: "Summary"
18+
description: "Briefly describe the bug."
19+
placeholder: "e.g., App crashes when opening settings"
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: description
25+
attributes:
26+
label: "Description"
27+
description: "Provide details about the bug."
28+
placeholder: "Explain the unexpected behavior in detail."
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: steps
34+
attributes:
35+
label: "Steps to Reproduce"
36+
description: "List the steps to reproduce the bug."
37+
placeholder: |
38+
1. Go to '...'
39+
2. Click on '...'
40+
3. See error"
41+
validations:
42+
required: false
43+
44+
- type: textarea
45+
id: expected_behavior
46+
attributes:
47+
label: "Expected Behavior"
48+
description: "What should happen instead?"
49+
placeholder: "Describe what you expected to happen."
50+
51+
- type: textarea
52+
id: additional_info
53+
attributes:
54+
label: "Additional Information"
55+
description: "Any extra context or screenshots?"
56+
placeholder: "Paste logs, screenshots, or links here."
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: "Feature Request"
2+
description: "Submit a new feature request"
3+
title: "[Feature Request]: "
4+
type: Feature
5+
6+
body:
7+
- type: textarea
8+
id: description
9+
attributes:
10+
label: "Description"
11+
description: "Provide a detailed description of the request, including the problem it solves and any relevant context."
12+
validations:
13+
required: true
14+
15+
- type: checkboxes
16+
id: security-requirement
17+
attributes:
18+
label: "Is this request a Security Requirement?"
19+
description: "If you select 'Yes,' please add the 'security-requirement' label."
20+
options:
21+
- label: "Yes"
22+
23+
- type: dropdown
24+
id: priority
25+
attributes:
26+
label: "Priority"
27+
description: "Select the priority level of this request."
28+
options:
29+
- High
30+
- Medium
31+
- Low
32+
validations:
33+
required: true
34+
35+
- type: input
36+
id: related_issues
37+
attributes:
38+
label: "Related Issues (Optional)"
39+
description: "Link any related GitHub issues."
40+
placeholder: "e.g., #123, #456"
41+
42+
- type: textarea
43+
id: additional_notes
44+
attributes:
45+
label: "Additional Notes (Optional)"
46+
description: "Provide any extra information or concerns regarding this request."

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## Fixes
2+
<!-- List the GitHub issue this PR resolves -->
3+
4+
- [#<Number>](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/<number>)
5+
6+
## Changes
7+
<!-- List the changes this PR introduces -->
8+
9+
-
10+
11+
## Screenshots
12+
<!-- Show UI changes with screenshots to ease UX/UI feedback: -->
13+
14+
## Checklist
15+
<!-- Put an `x` in the boxes. All tasks must be completed and boxes checked before merging. -->
16+
17+
<!-- TODO: Add a checklist -->

.github/dependabot.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "npm"
4+
directory: "/"
5+
open-pull-requests-limit: 10
6+
schedule:
7+
interval: "weekly"
8+
day: "sunday"
9+
ignore:
10+
- dependency-name: "@types/node"
11+
update-types:
12+
- version-update:semver-major
13+
14+
- package-ecosystem: "github-actions"
15+
directory: "/"
16+
schedule:
17+
interval: "weekly"
18+
day: "sunday"

.github/workflows/ci.yml

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- main
10+
workflow_dispatch:
11+
merge_group:
12+
release:
13+
types: [published]
14+
15+
jobs:
16+
build:
17+
name: Build and test
18+
runs-on: [ubuntu-latest]
19+
steps:
20+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
21+
with:
22+
fetch-depth: 0
23+
submodules: true
24+
25+
- uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
26+
with:
27+
node-version-file: package.json
28+
registry-url: https://npm.pkg.github.com
29+
always-auth: true
30+
cache: 'yarn'
31+
32+
- name: Set version
33+
run: |
34+
case ${{ github.event_name }} in
35+
release)
36+
TAG="${{ github.event.release.tag_name }}"
37+
yarn version --no-git-tag-version --new-version "${TAG#v}"
38+
;;
39+
pull_request)
40+
DESCRIBE=$(git describe --tags | grep -Eo 'v[0-9]+\.[0-9]+\.[0-9]+')
41+
QUALIFIER=$(git describe --tags | grep -Eo '\-g[0-9a-f]+$')
42+
yarn version -s --no-git-tag-version --new-version "${DESCRIBE#v}"
43+
yarn version --no-git-tag-version --prepatch --preid "pr${{ github.event.number }}${QUALIFIER}"
44+
;;
45+
*)
46+
DESCRIBE=$(git describe --tags | grep -Eo 'v[0-9]+\.[0-9]+\.[0-9]+')
47+
QUALIFIER=$(git describe --tags | grep -Eo '[0-9]+\-g[0-9a-f]+$')
48+
yarn version -s --no-git-tag-version --new-version "${DESCRIBE#v}"
49+
yarn version --no-git-tag-version --prepatch --preid "${{ github.ref_name }}${QUALIFIER}"
50+
;;
51+
esac
52+
VERSION="$(jq -r ".version" < package.json)"
53+
sed -i "s/## Unreleased/## ${VERSION}/" CHANGELOG.md
54+
echo "Version is ${VERSION}"
55+
56+
- name: Remove Badges for dist
57+
run: |
58+
sed -i "/https:\/\/codeclimate\.com\/github\/Open\-CMSIS\-Pack\/vscode\-cmsis\-debugger/d" README.md
59+
60+
- name: Build
61+
env:
62+
GITHUB_TOKEN: ${{github.token}}
63+
run: yarn --frozen-lockfile --prefer-offline
64+
65+
- name: Test
66+
run: yarn test
67+
68+
- name: Upload dist
69+
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
70+
with:
71+
name: dist
72+
path: |
73+
./README.md
74+
./CHANGELOG.md
75+
./package.json
76+
./dist
77+
retention-days: 1
78+
79+
- name: Commit changelog
80+
if: false && github.event_name == 'release'
81+
run: |
82+
sed -i '3i ## Unreleased\n' CHANGELOG.md
83+
git checkout main
84+
git config user.name github-actions
85+
git config user.email [email protected]
86+
git add CHANGELOG.md
87+
git commit -m "Update CHANGELOG.md after release [skip ci]"
88+
git push
89+
90+
- name: Publish coverage report to Code Climate
91+
uses: paambaati/codeclimate-action@f429536ee076d758a24705203199548125a28ca7 # v9.0.0
92+
env:
93+
CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
94+
with:
95+
debug: true
96+
coverageLocations: coverage/lcov.info:lcov
97+
98+
package:
99+
name: Package
100+
runs-on: [ubuntu-latest]
101+
needs: build
102+
strategy:
103+
fail-fast: true
104+
matrix:
105+
target:
106+
- win32-x64
107+
- linux-x64
108+
- linux-arm64
109+
- darwin-arm64
110+
steps:
111+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
112+
113+
- uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
114+
with:
115+
node-version-file: package.json
116+
registry-url: https://npm.pkg.github.com
117+
always-auth: true
118+
cache: 'yarn'
119+
120+
- name: Download dist
121+
uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
122+
with:
123+
name: dist
124+
path: .
125+
126+
- name: Cache tools
127+
uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.6
128+
with:
129+
path: tools
130+
key: tools-${{ matrix.target }}-${{ github.head_ref || github.ref_name }}
131+
restore-keys: |
132+
tools-${{ matrix.target }}-${{ github.base_ref || 'main' }}
133+
tools-${{ matrix.target }}-
134+
135+
- name: Download tools
136+
run: |
137+
yarn --frozen-lockfile --ignore-scripts --prefer-offline
138+
yarn download-tools --target ${{ matrix.target }} --no-cache
139+
140+
- name: Create vsix package (pre-release)
141+
run: |
142+
yarn package --target ${{ matrix.target }} --pre-release
143+
144+
- name: Upload package
145+
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
146+
with:
147+
name: vsix-package-${{ matrix.target }}
148+
path: ./*.vsix
149+
retention-days: 1
150+
151+
publish:
152+
name: Publish release
153+
runs-on: [ubuntu-latest]
154+
if: github.event_name == 'release'
155+
needs: package
156+
steps:
157+
- name: Download packages
158+
uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
159+
with:
160+
pattern: vsix-package-*
161+
162+
- name: Attach packages
163+
uses: softprops/action-gh-release@da05d552573ad5aba039eaac05058a918a7bf631 # v2.2.2
164+
with:
165+
files: "**/*.vsix"

0 commit comments

Comments
 (0)