v1.6.0 Release Preparations (#48)

* update to v1.6.0
* Udpate changelog
* update readme with contributing section
* added CONTRIBUTING.md
* added CODE_OF_CONDUCT.md
* update gh actions
* .vscodeignore updates
* added known issue with update install

Signed-off-by: Jens Reinecke <jens.reinecke@arm.com>

Author: jreineckearm

.github/workflows/ci.yml

@@ -16,10 +16,10 @@ jobs:
     name: Build
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: 14.x
       - name: Build
@@ -29,7 +29,7 @@ jobs:
           yarn install --ignore-scripts
           yarn build
           yarn package
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: vsix-package
           path: ./*.vsix
@@ -43,11 +43,11 @@ jobs:
       contents: write
     if: startsWith(github.ref, 'refs/tags/')
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/download-artifact@v3
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
         with:
           path: artifacts
-      - uses: softprops/action-gh-release@v1
+      - uses: softprops/action-gh-release@v2
         with:
           files: artifacts/*/*.vsix
 
@@ -57,11 +57,11 @@ jobs:
     runs-on: ubuntu-latest
     if: startsWith(github.ref, 'refs/tags/')
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/download-artifact@v3
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
         with:
           path: artifacts
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: 14.x
       - name: Publish
@@ -74,11 +74,11 @@ jobs:
     runs-on: ubuntu-latest
     if: startsWith(github.ref, 'refs/tags/')
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/download-artifact@v3
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
         with:
           path: artifacts
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: 14.x
       - name: Publish

.vscodeignore

@@ -1,7 +1,10 @@
+.eslintignore
 .github
+.gitignore
 .vscode
 node_modules
 src
+tsconfig.json
 *.vsix
 !node_modules/@vscode/codicons/dist/codicon.css
 !node_modules/@vscode/codicons/dist/codicon.ttf

CHANGELOG.md

@@ -1,5 +1,25 @@
 # Change Log
 
+## [v1.6.0] - 2025-02-06
+
+### New Features
+
+- Allow use of Peripheral Inspector in SSH remote scenario. ([Rob Moran](https://github.com/thegecko)).
+- Updated Peripheral Inspector to use [Ant Design](https://ant.design/docs/react/introduce/) React UI library ([Haydar Metin](https://github.com/haydar-metin), [Martin Fleck](https://github.com/martin-fleck-at), and others)
+- Added `Export Registers` functionality ([QuocTrung76](https://github.com/QuocTrung76))
+- Added `Search` functionality ([Martin Fleck](https://github.com/martin-fleck-at))
+- Added `Peripheral-inspector: Ignore Peripherals` extension setting to hide peripherals and skip reading their registers. Also added context menu entries to add and clear the setting on workspace level from the Peripheral Inspector view ([Haydar Metin](https://github.com/haydar-metin))
+
+### Other Changes
+
+- Updated extension logo.
+
+### Known Issue
+
+- As a side effect of moving to a custom Webview implementation, the Peripheral Inspector may show the following message when launched after update from a previous version:<br>
+`There is no data provider registered that can provide view data.`<br>
+***Solution***: Please restart your IDE after the update installation to overcome this problem. Restarting the extension may not be sufficient.
+
 ## [v1.5.1] - 2023-12-13
 
 ### Bug Fixes

CODE_OF_CONDUCT.md

@@ -0,0 +1,33 @@
+
+
+<div id="theia-logo" align="left">
+    <br />
+    <img src="https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/EF_GRY-OR_svg.svg?sanitize=true" alt="Eclipse Logo" width="300"/>
+</div>
+
+# Community Code of Conduct
+Version 1.0
+June 23, 2015
+
+As members of the Eclipse community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting code reviews, pull requests, patches, and other activities.
+
+We are committed to making participation in the Eclipse community a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion or analogous grounds.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Eclipse Foundation staff have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project leaders, committers and contributors who do not follow the Code of Conduct may be removed from the project.
+
+This code of conduct applies within Eclipse project spaces, or in public spaces when an individual is representing the project or the Eclipse community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by emailing the Eclipse Management Organization: codeofconduct@eclipse.org.
+
+This Code of Conduct is adapted from the Contributor Covenant (http://contributor-covenant.org), version 1.1.0, available at http://contributor-covenant.org/version/1/1/0/
+
+
+<div id="theia-logo" align="left">
+    <br />
+    <img src="https://www.eclipse.org/images/Eclipse_Code_of_Conduct.png" alt="Eclipse Logo" width="150"/>
+</div>
+
+----
+Note: Please see [here](https://www.eclipse.org/org/documents/Community_Code_of_Conduct.php) for the latest version of this document, hosted at the Eclipse Foundation

CONTRIBUTING.md

@@ -0,0 +1,71 @@
+# Contributing to Eclipse CDT Cloud Peripheral Inspector
+
+This repository is the home to the CDT Cloud Peripheral Inspector.
+
+## How Can I Contribute?
+
+In the following some of the typical ways of contribution are described.
+
+### Asking Questions
+
+It's totally fine to ask questions by opening an issue in the
+[GitHub repository](https://github.com/eclipse-cdt-cloud/vscode-peripheral-inspector).
+We will close it once it's answered and tag it with the 'question' label.
+Please check if the question has been asked before.
+
+### Reporting Bugs
+
+If you have found a bug, you should first check if it has already been filed
+and maybe even fixed in the
+[issues](https://github.com/eclipse-cdt-cloud/vscode-peripheral-inspector/issues).
+If you find an existing unresolved issue, please add your case. If you could not
+find an existing bug report, please
+[file a new one](https://github.com/eclipse-cdt-cloud/vscode-peripheral-inspector/issues/new/choose).
+In any case, please add all information you can share and that will help to
+reproduce and solve the problem.
+
+### Reporting Feature Requests
+
+You may want to see a feature or have an idea. You can
+[file a request](https://github.com/eclipse-cdt-cloud/vscode-peripheral-inspector/issues/new/choose)
+and we can discuss it. If such a feature request already exists, please add a comment
+or some other form of feedback to indicate you are interested, too. Also in this
+case any concrete use case scenario is appreciated to understand the motivation
+behind it.
+
+### Pull Requests
+
+Before you get started investing significant time in something you want to get
+merged and maintained as part of this project, you should talk with the team
+by posting on an issue. Simply choose the issue you would want to work on, and tell everyone
+that you are willing to do so and how you would approach it. The team will be
+happy to guide you and give feedback.
+
+## Eclipse Contributor Agreement
+
+Before your contribution can be accepted by the project team contributors must
+electronically sign the Eclipse Contributor Agreement (ECA).
+
+* http://www.eclipse.org/legal/ECA.php
+
+Commits that are provided by non-committers must have a Signed-off-by field in
+the footer indicating that the author is aware of the terms by which the
+contribution has been provided to the project. The non-committer must
+additionally have an Eclipse Foundation account and must have a signed Eclipse
+Contributor Agreement (ECA) on file.
+
+For more information, please see the Eclipse Committer Handbook:
+https://www.eclipse.org/projects/handbook/#resources-commit
+
+## Sign your work
+
+The sign-off is a simple line at the end of the explanation for the patch. Your
+signature certifies that you wrote the patch or otherwise have the right to
+pass it on as an open-source patch.
+
+    Signed-off-by: Joe Smith <joe.smith@email.com>
+
+Use your real name (sorry, no pseudonyms or anonymous contributions.)
+
+If you set your `user.name` and `user.email` git configs, you can sign your
+commit automatically with `git commit -s`.

README.md

@@ -101,3 +101,9 @@ Additionally the following settings can be used to customize the Peripheral Insp
 
 - `peripheral-inspector.saveLayout`- Save layout of peripheral view between sessions (default: `true`)
 - `peripheral-inspector.ignorePeripherals` - List of peripheral names to ignore. They will not show up in the tree view and no values are read from the target system. The user can add variables by using the context menu (**Workspace only**) in the tree view, or by setting them manually in the **User** and **Workspace** preferences.
+
+## Contributing
+
+We welcome contributions on [GitHub](https://github.com/eclipse-cdt-cloud/vscode-peripheral-inspector).
+Check our [contribution guidelines](./CONTRIBUTING.md) for more info.
+This open-source project is part of [Eclipse CDT Cloud](https://eclipse.dev/cdt-cloud/).

package.json

@@ -2,7 +2,7 @@
   "name": "peripheral-inspector",
   "displayName": "Peripheral Inspector",
   "description": "Standalone Peripheral Inspector extension extracted from cortex-debug",
-  "version": "1.5.1",
+  "version": "1.6.0",
   "publisher": "eclipse-cdt",
   "author": "marus25",
   "contributors": [
@@ -350,4 +350,4 @@
     "workspace",
     "ui"
   ]
-}
+}