@nordicsemiconductor/pc-nrfconnect-shared 218.0.0 → 220.0.0

package/Changelog.md

@@ -7,6 +7,23 @@ This project does _not_ adhere to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html) but contrary to it
 every new version is a new major version.
 
+## 220.0.0 - 2025-07-16
+
+### Added
+
+-   Option to persist the Group collapse state.
+
+### Changed
+
+-   Use `tsx` instead of `ts-node`.
+-   Switched releasing shared from Azure to GitHub Actions.
+
+## 219.0.0 - 2025-07-10
+
+### Fixed
+
+-   Error when verbose logging was turned on.
+
 ## 218.0.0 - 2025-07-08
 
 ### Fixed

package/README.md

@@ -9,3 +9,31 @@ apps and their launcher:
 -   Build scripts
 -   Configurations
 -   Test facilities
+
+## Releasing
+
+This project uses GitHub Actions for automated releases. To release a new
+version:
+
+### Prepare the release
+
+-   Update the version in `package.json`.
+-   Add a changelog entry in `Changelog.md` with the format:
+    `## X.0.0 - YYYY-MM-DD`.
+-   Commit and push your changes
+
+### Create the release
+
+-   Go to the the
+    [Release shared](https://github.com/NordicSemiconductor/pc-nrfconnect-shared/actions/workflows/release-shared.yml)
+    action.
+-   Click "Run workflow".
+-   Optionally select a ref to release, but usually this should be `main` and
+    can be left empty.
+
+The workflow will:
+
+-   Check if a release is possible.
+-   Build and test the package.
+-   Create a GitHub release.
+-   Publish to npm.

package/config/tsconfig.json

@@ -1,6 +1,4 @@
 {
-    "ts-node": { "swc": true },
-
     "compilerOptions": {
         "target": "es2021",
         "moduleResolution": "node",

package/dist/bootstrap.css

@@ -1,6 +1,6 @@
 @charset "UTF-8";
 
-/* stylePlugin:/home/vsts/work/1/s/src/bootstrap.scss */
+/* stylePlugin:/home/runner/work/pc-nrfconnect-shared/pc-nrfconnect-shared/src/bootstrap.scss */
 :root {
   --blue: #007bff;
   --indigo: #3f51b5;

package/nrfutil/sandbox.ts

@@ -140,9 +140,9 @@ export class NrfutilSandbox {
     public isSandboxInstalled = () =>
         this.executableExists() && this.commandReportsCorrectVersion();
 
-    private log(message: LogMessage, pid: number | undefined) {
+    private log = (message: LogMessage, pid: number | undefined) => {
         this.onLoggingHandlers.forEach(onLogging => onLogging(message, pid));
-    }
+    };
 
     private executableExists() {
         return fs.existsSync(

package/package.json

@@ -1,18 +1,18 @@
 {
     "name": "@nordicsemiconductor/pc-nrfconnect-shared",
-    "version": "218.0.0",
+    "version": "220.0.0",
     "description": "Shared commodities for developing pc-nrfconnect-* packages",
     "repository": {
         "type": "git",
-        "url": "https://github.com/NordicSemiconductor/pc-nrfconnect-shared.git"
+        "url": "git+https://github.com/NordicSemiconductor/pc-nrfconnect-shared.git"
     },
     "author": "Nordic Semiconductor ASA",
     "license": "ISC",
     "bin": {
-        "check-for-typescript": "./scripts/check-for-typescript.ts",
-        "check-app-properties": "./scripts/check-app-properties.ts",
-        "nrfconnect-license": "./scripts/nrfconnect-license.ts",
-        "run-esbuild": "./scripts/esbuild.ts"
+        "check-for-typescript": "scripts/check-for-typescript.ts",
+        "check-app-properties": "scripts/check-app-properties.ts",
+        "nrfconnect-license": "scripts/nrfconnect-license.ts",
+        "run-esbuild": "scripts/esbuild.ts"
     },
     "main": "src",
     "scripts": {
@@ -20,13 +20,12 @@
         "check": "run-p --silent --continue-on-error --print-label check:*",
         "check:lint": "eslint --color .",
         "check:types": "tsc --noEmit",
-        "check:license": "ts-node scripts/nrfconnect-license.ts check",
+        "check:license": "tsx scripts/nrfconnect-license.ts check",
         "generate-types": "tsc --emitDeclarationOnly --declaration --declarationMap --outDir ./typings/generated --rootDir .",
-        "prepare": "ts-node scripts/installHusky.ts",
-        "release-shared": "ts-node scripts/release-shared.ts",
-        "prepare-shared-release": "ts-node scripts/prepare-shared-release.ts",
+        "prepare": "tsx scripts/installHusky.ts",
+        "prepare-shared-release": "tsx scripts/prepare-shared-release.ts",
         "clean": "rimraf dist typings/generated scripts/nordic-publish.js",
-        "postinstall": "ts-node scripts/postinstall.ts"
+        "postinstall": "tsx scripts/postinstall.ts"
     },
     "dependencies": {
         "@electron/remote": "^2.1.2",
@@ -117,7 +116,7 @@
         "systeminformation": "^5.25.11",
         "tailwindcss": "3.3.2",
         "tree-kill-promise": "^3.0.14",
-        "ts-node": "10.9.1",
+        "tsx": "^4.20.3",
         "typescript": "4.9.5",
         "util": "0.12.5",
         "uuid": "8.3.2",

package/release_notes.md

@@ -0,0 +1,8 @@
+### Added
+
+-   Option to persist the Group collapse state.
+
+### Changed
+
+-   Use `tsx` instead of `ts-node`.
+-   Switched releasing shared from Azure to GitHub Actions.

package/scripts/check-app-properties.ts

@@ -1,4 +1,4 @@
-#!/usr/bin/env ts-node
+#!/usr/bin/env -S npx tsx
 
 /*
  * Copyright (c) 2022 Nordic Semiconductor ASA
@@ -11,6 +11,7 @@ import { existsSync, readdirSync, readFileSync } from 'fs';
 import property from 'lodash/property';
 
 import { PackageJsonApp, parsePackageJsonApp } from '../ipc/schema/packageJson';
+import { getLatestEntry } from './latest-changelog-entry';
 
 const format = (strings: string[]) =>
     strings.map(string => `\`${string}\``).join(', ');
@@ -132,9 +133,6 @@ const readAndCheckPackageJson = () => {
     return packageJson;
 };
 
-const changelogEntryRegexp = (version?: string) =>
-    new RegExp(`^## ${version}`, 'mi');
-
 const checkChangelog = (
     packageJson: PackageJsonApp,
     checkChangelogHasCurrentEntry: boolean
@@ -148,16 +146,12 @@ const checkChangelog = (
             fail('package.json must specify a `version`.');
         }
 
-        const changelog = readFileSync('./Changelog.md', 'utf8');
-        if (!changelog.match(changelogEntryRegexp(packageJson.version))) {
+        const latestChangelogEntry = getLatestEntry();
+        if (!latestChangelogEntry.header.includes(packageJson.version)) {
             fail(
                 `Found no entry for the current version packageJson.version ${packageJson.version} in \`Changelog.md\`.`
             );
         }
-
-        if (changelog.match(changelogEntryRegexp('unreleased'))) {
-            fail('There must not be an entry `unreleased` in `Changelog.md`.');
-        }
     }
 };
 

package/scripts/check-for-typescript.ts

@@ -1,4 +1,4 @@
-#!/usr/bin/env ts-node
+#!/usr/bin/env -S npx tsx
 
 /*
  * Copyright (c) 2015 Nordic Semiconductor ASA

package/scripts/create-source.ts

@@ -1,4 +1,4 @@
-#!/usr/bin/env ts-node
+#!/usr/bin/env -S npx tsx
 
 /*
  * Copyright (c) 2025 Nordic Semiconductor ASA

package/scripts/esbuild.ts

@@ -1,4 +1,4 @@
-#!/usr/bin/env ts-node
+#!/usr/bin/env -S npx tsx
 /*
  * Copyright (c) 2015 Nordic Semiconductor ASA
  *

package/scripts/get-release-numbers.ts

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2025 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import { execSync } from 'node:child_process';
+
+const getLatestReleaseName = () => {
+    const latestReleaseJson = execSync(`gh release view --json tagName`, {
+        encoding: 'utf-8',
+    });
+    const latestRelease = JSON.parse(latestReleaseJson) as { tagName: string };
+
+    return latestRelease.tagName;
+};
+
+export default (latestReleaseName = getLatestReleaseName()) => {
+    const latest = Number(
+        /^v(?<versionNumber>\d+)$/.exec(latestReleaseName)?.groups
+            ?.versionNumber
+    );
+
+    return { latest, next: latest + 1 };
+};

package/scripts/installHusky.ts

@@ -1,4 +1,4 @@
-#!/usr/bin/env ts-node
+#!/usr/bin/env -S npx tsx
 
 /*
  * Copyright (c) 2022 Nordic Semiconductor ASA

package/scripts/is-releasable.ts

@@ -0,0 +1,68 @@
+#!/usr/bin/env -S npx tsx
+
+/*
+ * Copyright (c) 2025 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+/*
+  A script to check if the current state of the repository is releasable.
+
+  Requirement for this script: Have [the GitHub CLI tool `gh`](https://cli.github.com)
+  installed and authenticate in it (run `gh auth login`).
+*/
+
+import packageJson from '../package.json';
+import getReleaseNumbers from './get-release-numbers';
+import { getLatestEntry } from './latest-changelog-entry';
+
+const fail = (message: string) => {
+    console.log(`::error::${message}`);
+    process.exit(1);
+};
+
+const assertPackageJsonIsCorrect = (expectedVersionNumber: number) => {
+    if (packageJson.version !== `${expectedVersionNumber}.0.0`) {
+        fail(
+            `Version number in package.json must be '${expectedVersionNumber}.0.0' but is '${packageJson.version}'`
+        );
+    }
+};
+
+const assertLatestEntryIsNotEmpty = () => {
+    if (getLatestEntry().content.length === 0) {
+        fail('Latest entry in `Changelog.md` does not contain anything.');
+    }
+};
+
+const today = () => new Date().toISOString().split('T')[0];
+
+const assertLatestHeaderIsCorrect = (expectedVersionNumber: number) => {
+    const expectedHeaderline = `${expectedVersionNumber}.0.0 - ${today()}`;
+    const actualHeaderline = getLatestEntry().header;
+
+    if (expectedHeaderline !== actualHeaderline) {
+        fail(
+            `Latest entry in Changelog.md is not as expected:\n  Expected: ${expectedHeaderline}\n  Actual:   ${actualHeaderline}`
+        );
+    }
+};
+
+const assertChangelogIsCorrect = (expectedVersionNumber: number) => {
+    assertLatestEntryIsNotEmpty();
+    assertLatestHeaderIsCorrect(expectedVersionNumber);
+};
+
+const main = () => {
+    const releaseNumbers = getReleaseNumbers();
+
+    assertPackageJsonIsCorrect(releaseNumbers.next);
+    assertChangelogIsCorrect(releaseNumbers.next);
+
+    console.log(
+        `The currently released version is ${releaseNumbers.latest}, so the next one will be ${releaseNumbers.next}.\n`
+    );
+};
+
+main();

package/scripts/latest-changelog-entry.test.ts

@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) 2025 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import { getLatestEntry } from './latest-changelog-entry';
+
+describe('getLatestEntry', () => {
+    it('should extract the latest changelog entry correctly', () => {
+        const changelog = `# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## 34.0.0 - 2022-03-10
+
+### Changed
+
+-   Something
+
+## 33.0.0 - 2022-02-01
+
+### Added
+- Basic stuff`;
+
+        const result = getLatestEntry(changelog);
+
+        expect(result.header).toBe('34.0.0 - 2022-03-10');
+        expect(result.content).toBe('### Changed\n\n-   Something');
+    });
+
+    it('should handle changelog with only one entry', () => {
+        const changelog = `# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## 33.0.0 - 2022-02-01
+
+### Added
+
+-   Something else`;
+
+        const result = getLatestEntry(changelog);
+
+        expect(result.header).toBe('33.0.0 - 2022-02-01');
+        expect(result.content).toBe('### Added\n\n-   Something else');
+    });
+
+    it('should handle changelog with empty content', () => {
+        const changelog = `# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## 34.0.0 - 2022-03-10
+
+## 33.0.0 - 2022-02-01
+
+### Added
+
+-   Something else`;
+
+        const result = getLatestEntry(changelog);
+
+        expect(result.header).toBe('34.0.0 - 2022-03-10');
+        expect(result.content).toBe('');
+    });
+
+    it('should handle changelog with nothing before the first entry', () => {
+        const changelog = `## 33.0.0 - 2022-02-01
+
+### Added
+
+-   Something else`;
+
+        const result = getLatestEntry(changelog);
+
+        expect(result.header).toBe('33.0.0 - 2022-02-01');
+        expect(result.content).toBe('### Added\n\n-   Something else');
+    });
+});

package/scripts/latest-changelog-entry.ts

@@ -0,0 +1,25 @@
+#!/usr/bin/env -S npx tsx
+
+/*
+ * Copyright (c) 2025 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import { readFileSync } from 'node:fs';
+
+const readChangelog = () => readFileSync('Changelog.md', 'utf-8');
+
+export const getLatestEntry = (changelog = readChangelog()) => {
+    const latestEntry = changelog.split(/(?:^|\n)## /)[1];
+
+    const header = latestEntry.split('\n')[0];
+    const content = latestEntry.replace(/[^\n]*/, '').trim();
+
+    return { header, content };
+};
+
+const runAsScript = require.main === module;
+if (runAsScript) {
+    console.log(getLatestEntry().content);
+}