Skip to content

Commit 709d83e

Browse files
authored
Merge branch 'main' into check-links
2 parents 9518ec2 + 9b44ed2 commit 709d83e

14 files changed

Lines changed: 133 additions & 133 deletions

File tree

.devcontainer/ubuntu-24.04/.npmrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
@arm-debug:registry=https://npm.pkg.github.com
1+
@open-cmsis-pack:registry=https://npm.pkg.github.com
22
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 6 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,20 @@
11
name: Bug Report
2-
description: Report a bug
3-
title: "[Bug]: "
2+
description: File a bug/issue
3+
title: "<title>"
44
type: "Bug"
5-
projects: ""
6-
labels: []
7-
assignees: []
5+
projects:
6+
- Open-CMSIS-Pack/24
87

98
body:
10-
- type: markdown
11-
attributes:
12-
value: "### Thank you for reporting a problem!"
13-
149
- type: textarea
1510
id: description
1611
attributes:
17-
label: "Description"
12+
label: "Current behavior, Steps to reproduce and Expected behavior"
1813
description: "Provide details about the bug."
19-
placeholder: "Explain the unexpected behavior in detail."
14+
placeholder: "Explain the unexpected behavior, steps to reproduce and expected behavior..."
2015
validations:
2116
required: true
2217

23-
- type: textarea
24-
id: steps
25-
attributes:
26-
label: "Steps to Reproduce"
27-
description: "List the steps to reproduce the bug."
28-
placeholder: |
29-
1. Go to '...'
30-
2. Click on '...'
31-
3. See error"
32-
validations:
33-
required: false
34-
35-
- type: textarea
36-
id: expected_behavior
37-
attributes:
38-
label: "Expected Behavior"
39-
description: "What should happen instead?"
40-
placeholder: "Describe what you expected to happen."
41-
4218
- type: textarea
4319
id: additional_info
4420
attributes:

.github/workflows/ci.yml

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ jobs:
7777
run: npm run build
7878

7979
- name: Update current version
80+
if: github.event_name != 'release'
8081
run: |
8182
# Increment patch version by 1 (e.g. 1.64.1 -> 1.64.2)
8283
BASE_VERSION=$(node -p "require('./package.json').version.split('-')[0]")
@@ -102,12 +103,12 @@ jobs:
102103
# Get short commit SHA
103104
SHORT_SHA=$(git rev-parse --short HEAD)
104105
105-
# Create nightly version: 1.64.2-12-abc1234
106-
NIGHTLY_VERSION="${NEXT_PATCH_VERSION}-${COMMIT_COUNT}-${SHORT_SHA}"
107-
echo "Setting version to ${NIGHTLY_VERSION}"
106+
# Create PR version: 1.64.2-12-abc1234
107+
PR_VERSION="${NEXT_PATCH_VERSION}-${COMMIT_COUNT}-${SHORT_SHA}"
108+
echo "Setting version to ${PR_VERSION}"
108109
109110
# Update package.json
110-
npm version "${NIGHTLY_VERSION}" --no-git-tag-version
111+
npm version "${PR_VERSION}" --no-git-tag-version
111112
112113
- name: Remove badges
113114
run: |
@@ -314,20 +315,6 @@ jobs:
314315
pattern: unit-test-coverage
315316
path: test-coverage
316317

317-
- name: Download test report
318-
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
319-
with:
320-
pattern: test-report-linux
321-
path: test-report-linux
322-
323-
- name: Zip test report
324-
run: zip -r test-report.zip *
325-
working-directory: test-report-linux
326-
327-
- name: Zip test coverage
328-
run: zip -r test-coverage.zip *
329-
working-directory: test-coverage
330-
331318
- name: Attach packages
332319
uses: softprops/action-gh-release@153bb8e04406b158c6c84fc1615b65b24149a1fe # v2.6.1
333320
with:

CHANGELOG.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
11
# Change Log
22

3-
## [Unreleased]
3+
## 1.67.0
4+
5+
- Updates:
6+
- Minimum required version of VS Code for using this extension is **^1.108.1**.
7+
- **CMSIS View** resolves [access sequences](https://open-cmsis-pack.github.io/cmsis-toolbox/YML-Input-Format/#access-sequences) used in file references and opens the corresponding physical file on click.
8+
- Extended support for file links in editor windows for [CMSIS Solution Project](https://open-cmsis-pack.github.io/cmsis-toolbox/YML-Input-Format/#project-file-structure) and [build information](https://open-cmsis-pack.github.io/cmsis-toolbox/YML-CBuild-Format) files.
9+
- Extended solution conversion diagnostics to collect and surface errors and warnings from orchestrated tools (cpackget, cbuild, cbuild2cmake, csolution) in the VS Code Problems view. Messages are removed from the status bar tooltip.
10+
- Solution conversion is now skipped if missing packs are detected but cannot be downloaded and installed by the pack installer `cpackget`.
11+
- Added `Config File` option in Debug Adapter for Arm-FVP to open the specified file.
12+
13+
- Solved issues:
14+
- **CMSIS View** does not load and display CMSIS Solution files without `projects:` node which is the case for debug only setups.
15+
- **Software Components** does not reliably open the initial view for the selected layer.
16+
- **Manage Solution** dialog target-type handling breaks in case the corresponding node is changed in `*.csolution.yml` on disk.
17+
- `uVision option` in Debug Adapter for Keil uVision stores absolute filepath.
18+
419

520
## 1.66.0
621

DEVELOPMENT.md

Lines changed: 22 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -33,22 +33,20 @@ In short, run this command from the extracted directory on the Arm network:
3333
## Running the extension in development
3434

3535
1. To download the tools, you must have a `GITHUB_TOKEN` environment variable containing a
36-
personal access token. This must have the `repo` scope and SSO enabled for the Arm-Debug
37-
organization.
36+
personal access token.
3837

39-
2. In order to install dependencies, you must have npm configured to access the Arm-Debug registry
40-
for packages that are scoped with `@arm-debug`. Edit your global .npmrc file, and add the
38+
2. In order to install dependencies, Edit your global .npmrc file, and add the
4139
following to it:
4240

4341
```txt
44-
@arm-debug:registry=https://npm.pkg.github.com
42+
@open-cmsis-pack:registry=https://npm.pkg.github.com
4543
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}
4644
```
4745
4846
This assumes a `GITHUB_TOKEN` environment variable is exported in your environment. This needs
4947
to be a GitHub personal access token with the `read:packages` scope set on it.
5048
51-
3. Install NPM dependencies, Core Tools and build the TypeScript
49+
3. Install NPM dependencies and build the TypeScript
5250
5351
```sh
5452
npm install
@@ -171,18 +169,6 @@ when running in development mode.
171169
Before running a release, check the following:
172170
173171
1. Tools and schemas integrated into the extension packages according to `package.json`
174-
- CoreTools version referenced by the dependency (see `dependencies` section)
175-
176-
`"@arm-debug/cmsis-core-tools-client": "<version>"`
177-
178-
`version` must match a [CoreTools release](https://github.com/Arm-Debug/cmsis-core-tools/tags)
179-
180-
- uv2csolution version referenced in `csolution` section
181-
182-
`"uv2csolutionVersion": "<version>"`
183-
184-
`<version>` must match a [uvprojx-converter release](https://github.com/Arm-Debug/uvprojx-converter/releases)
185-
186172
- schema version referenced in `csolution` section
187173
188174
`"schemaVersion": "<version>"`
@@ -198,59 +184,32 @@ Before running a release, check the following:
198184
199185
4. [Release Assessment](https://armh.sharepoint.com/sites/pwa/PJ1000480/SitePages/Assessments.aspx) for `CMSIS Solution Extension` is approved.
200186
201-
### Release workflow
187+
## Release versioning
202188
203-
Use GitHub Actions workflow dispatch to trigger a release:
189+
This repository follows the VS Code Marketplace pre-release recommendation:
204190
205-
1. Navigate to <https://github.com/Arm-Debug/vscode-cmsis-csolution/actions/workflows/ci.yml>,
206-
then click "Run workflow"
207-
2. Select the main branch
208-
3. Select type of new version, e.g. 'Minor'
209-
4. Select "Skip public publishing jobs' if the version should be created on GitHub but NOT being
210-
published to Marketplace
211-
5. Click "Run workflow"
191+
- **Odd** minor versions (`x.1.z`, `x.3.z`, ...) are pre-releases.
192+
- **Even** minor versions (`x.0.z`, `x.2.z`, ...) are full releases.
212193
213-
Notes
194+
To enforce this consistently, both packaging and publishing use `scripts/package.ts`, which:
214195
215-
- When 'Pre-release' is selected, the version is either:
216-
- incremented according the latest published pre-release (patch +1), if it is greater than the current version
217-
- incremented according the the current version, newMinorVersion is always an odd number (including 0), e.g. 0,1,3,...
218-
- When 'Major', 'Minor' or 'Patch' is selected, the version will be increased and the new version
219-
number will be committed to package.json. If a second release is triggered, it will also be
220-
increased, regardless of being pushed to marketplace or not.
221-
- 'Major' increments major version
222-
- 'Minor' increments to an even number, e.g. 0,2,4,...
223-
- 'Patch' increments patch version
224-
- see [vscode-actions](https://github.com/Arm-Debug/vscode-actions/blob/main/calculate-new-version/src/bump-version.ts)
196+
- checks the current `package.json` version minor value.
197+
- automatically adds `--pre-release` to `vsce package` for odd minor versions.
225198
226-
Github actions will then
199+
Use the following commands:
227200
228-
- Bump the versions in the package.json files
229-
- Add the new version to the CHANGELOG.md, and move all changes listed under "Unreleased" to the new version.
230-
- Commit and push the version and changelog updates
231-
- Build the VSIX package
232-
- Create a GitHub release with the VSIX package
233-
- Publish the package on [Open VSX](https://open-vsx.org/extension/arm/cmsis-csolution) and [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=Arm.cmsis-csolution)
234-
- Publish the API types to the Arm-Debug GitHub Packages npm registry
235-
- Sync the docs to [ARM-software/vscode-cmsis-csolution](https://github.com/ARM-software/vscode-cmsis-csolution)
236-
237-
After publishing, check that the new version is installable in VSCode and docs for the new version
238-
have been synced to Arm-Software.
239-
240-
### Publishing to VS Code Marketplace
241-
242-
The marketplace access token is controlled by the [DSG-OTG](https://dev.azure.com/DSG-OTG)
243-
organization in Azure. It is available in CI as an Arm-Debug GitHub organization secret. This must
244-
be rotated every 90 days.
245-
246-
See the documentation for publishing extensions:
247-
<https://code.visualstudio.com/api/working-with-extensions/publishing-extension>
201+
```sh
202+
> npm run package [--target <target>]
203+
```
248204
249-
### Publishing Open-VSX
205+
### Release Workflow
250206
251-
The arm namespace Open-VSX is accessible from your [user settings](https://open-vsx.org/user-settings)
252-
when your GitHub account has been linked to the arm namespace. An access token is stored as an
253-
Arm-Debug GitHub organization secret.
207+
1. Ensure the version in `package.json` is up to date.
208+
2. Update the `CHANGELOG` with the latest changes.
209+
3. Open a pull request with these updates and merge it into `main`.
210+
4. Create a new release at: https://github.com/Open-CMSIS-Pack/vscode-cmsis-solution/releases
211+
- This will trigger the `CI.yml` workflow.
212+
- Once the workflow completes successfully, the release artifacts will be generated automatically.
254213
255214
## Debugging in KSC
256215

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Action buttons allow you to build, run, and debug your application, [edit *csolu
5353

5454
The **CMSIS** view displays the name of the current *csolution project* and offers several action buttons.
5555

56-
![Action buttons](https://github.com/ARM-software/vscode-cmsis-csolution/raw/main/docs/images/ActionButtons.png)
56+
![Action buttons](https://github.com/Open-CMSIS-Pack/vscode-cmsis-solution/raw/main/docs/images/ActionButtons.png)
5757

5858
| Action | Description |
5959
|--------|-------------|
@@ -69,7 +69,7 @@ The **CMSIS** view displays the name of the current *csolution project* and offe
6969

7070
## Create Solution view
7171

72-
![Create Solution](https://github.com/ARM-software/vscode-cmsis-csolution/raw/main/docs/images/CreateNewSolution.png)
72+
![Create Solution](https://github.com/Open-CMSIS-Pack/vscode-cmsis-solution/raw/main/docs/images/CreateNewSolution.png)
7373

7474
To start a new *csolution project*, select a [board](https://www.keil.arm.com/boards/) or [device](https://www.keil.arm.com/devices/) and choose from the following project types:
7575

@@ -82,33 +82,33 @@ Then create the *csolution project* on the selected folder on your Host computer
8282

8383
## Configure Solution view
8484

85-
![Configure Solution](https://github.com/ARM-software/vscode-cmsis-csolution/raw/main/docs/images/ConfigureSolution.png)
85+
![Configure Solution](https://github.com/Open-CMSIS-Pack/vscode-cmsis-solution/raw/main/docs/images/ConfigureSolution.png)
8686

8787
When using a [reference application](https://open-cmsis-pack.github.io/cmsis-toolbox/ReferenceApplications/) select compatible software layers for your solution from this view.
8888

8989
## Software Components view
9090

91-
![Software Components](https://github.com/ARM-software/vscode-cmsis-csolution/raw/main/docs/images/SoftwareComponents.png)
91+
![Software Components](https://github.com/Open-CMSIS-Pack/vscode-cmsis-solution/raw/main/docs/images/SoftwareComponents.png)
9292

9393
Select reusable software components for your application from this view.
9494

9595
[CMSIS-Packs](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/index.html) provide software components with other optional items such as configuration files, documentation, and user code templates. A software component typically interfaces with other software components or with device peripherals. The list of software components depends on the device or board selected.
9696

9797
## Manage Solution view
9898

99-
![Manage Solution](https://github.com/ARM-software/vscode-cmsis-csolution/raw/main/docs/images/ManageSolution.png)
99+
![Manage Solution](https://github.com/Open-CMSIS-Pack/vscode-cmsis-solution/raw/main/docs/images/ManageSolution.png)
100100

101101
Select the [target](https://open-cmsis-pack.github.io/cmsis-toolbox/build-overview/#target-production-hardware) and configure [related projects](https://open-cmsis-pack.github.io/cmsis-toolbox/build-overview/#configure-related-projects) for your application from this view. A Target Set stores settings for projects, images and debug adapter. You might need different build types or load settings, for example to reduce the debug overhead. Refer also to [Run and Debug](#run-and-debug) below.
102102

103103
## Configuration Wizard
104104

105-
![Configuration Wizard](https://github.com/ARM-software/vscode-cmsis-csolution/raw/main/docs/images/ConfigWizard.png)
105+
![Configuration Wizard](https://github.com/Open-CMSIS-Pack/vscode-cmsis-solution/raw/main/docs/images/ConfigWizard.png)
106106

107107
Many configuration files have annotations for the [CMSIS Configuration Wizard](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/configWizard.html). Using the **Open Preview** button in the editor allows you to modify options in a graphical view.
108108

109109
## YML Editor Support
110110

111-
![YML Editor Support](https://github.com/ARM-software/vscode-cmsis-csolution/raw/main/docs/images/SyntaxYML.png)
111+
![YML Editor Support](https://github.com/Open-CMSIS-Pack/vscode-cmsis-solution/raw/main/docs/images/SyntaxYML.png)
112112

113113
The YML syntax support in the editor detects errors, provides auto completion, and documentation links on hover over.
114114

@@ -138,4 +138,4 @@ The [Run and Debug configuration](https://mdk-packs.github.io/vscode-cmsis-solut
138138
139139
## Submit feedback or report issues
140140
141-
To submit feedback or report issues on the Arm CMSIS Solution extension, please use [GitHub issues](https://github.com/ARM-software/vscode-cmsis-csolution/issues) in the extension repository.
141+
To submit feedback or report issues on the Arm CMSIS Solution extension, please use [GitHub issues](https://github.com/Open-CMSIS-Pack/vscode-cmsis-solution/issues) in the extension repository.

docs/third-party-licenses.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# TPIP Report for vscode-cmsis-csolution
1+
# TPIP Report for vscode-cmsis-solution
22

33
Report prepared at: 03/03/2026, 10:51:48
44

docs/tpip-header.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
# TPIP Report for vscode-cmsis-csolution
1+
# TPIP Report for vscode-cmsis-solution

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22
"name": "cmsis-csolution",
33
"displayName": "Arm CMSIS Solution",
44
"description": "Create embedded and Edge AI projects for Arm Cortex-M based devices using the Common Microcontroller Software Interface Standard (CMSIS) and csolution format",
5-
"version": "1.66.0",
5+
"version": "1.67.1",
66
"preview": false,
77
"publisher": "Arm",
8-
"author": "Rob Moran <rob.moran@arm.com>",
8+
"author": "Jens Reinecke <jens.reinecke@arm.com>",
99
"license": "SEE LICENSE IN LICENSE",
1010
"main": "dist/extension.js",
11-
"repository": "https://github.com/ARM-software/vscode-cmsis-csolution",
12-
"qna": "https://github.com/ARM-software/vscode-cmsis-csolution/issues/new/choose",
11+
"repository": "https://github.com/Open-CMSIS-Pack/vscode-cmsis-solution",
12+
"qna": "https://github.com/Open-CMSIS-Pack/vscode-cmsis-solution/issues/new/choose",
1313
"bugs": {
14-
"url": "https://github.com/ARM-software/vscode-cmsis-csolution/issues"
14+
"url": "https://github.com/Open-CMSIS-Pack/vscode-cmsis-solution/issues"
1515
},
1616
"icon": "media/arm.png",
1717
"galleryBanner": {

0 commit comments

Comments
 (0)