@nordicsemiconductor/pc-nrfconnect-shared 197.0.0 → 199.0.0

package/Changelog.md

@@ -7,6 +7,32 @@ 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.
 
+## 199.0.0 - 2025-02-20
+
+### Fixed
+
+-   `nordic-publish.ts` deleted the description of a source.
+
+## 198.0.0 - 2025-02-12
+
+### Added
+
+-   Support for publishing apps to Artifactory.
+
+### Fixed
+
+-   Product links for nRF54L15 DK, nRF54H20 DK, nRF9131 EK, nRF9151 DK, nRF9161
+    DK, and Nordic Thingy:91 X.
+
+### Steps to upgrade when using this package
+
+-   When publishing the app via FTP (usually in the azure release pipeline), add
+    the parameter `--destination ftp` when calling the nordic-publish script.
+-   Copy the files `build.yml`, `release.yml`, and `release-latest.yml` from
+    https://github.com/NordicSemiconductor/pc-nrfconnect-boilerplate/tree/main/.github/workflows
+    to `.github/workflows`. If appropriate for an app, customise the list of
+    sources to deploy to in `release.yml`.
+
 ## 197.0.0 - 2025-02-05
 
 ### Added

package/ipc/MetaFiles.ts

@@ -10,6 +10,7 @@ export type UrlString = string;
 
 export const sourceJsonSchema = z.object({
     name: z.string(),
+    description: z.string().optional(),
     apps: z.array(z.string().url()),
 });
 export type SourceJson = z.infer<typeof sourceJsonSchema>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nordicsemiconductor/pc-nrfconnect-shared",
-    "version": "197.0.0",
+    "version": "199.0.0",
     "description": "Shared commodities for developing pc-nrfconnect-* packages",
     "repository": {
         "type": "git",
@@ -125,6 +125,9 @@
         "zod": "^3.22.2",
         "zod-validation-error": "^1.5.0"
     },
+    "devDependencies": {
+        "@commander-js/extra-typings": "^10.0.3"
+    },
     "typings": "./typings/generated/src/index.d.ts",
     "eslintConfig": {
         "extends": "./config/eslintrc"

package/scripts/create-source.ts

@@ -0,0 +1,78 @@
+#!/usr/bin/env ts-node
+
+/*
+ * Copyright (c) 2025 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import { Command, Option } from '@commander-js/extra-typings';
+
+import { SourceJson } from '../ipc/MetaFiles';
+
+const fail = (message: string) => {
+    console.error(message);
+    process.exit(1);
+};
+
+if (process.env.ARTIFACTORY_TOKEN == null)
+    fail('The environment variable ARTIFACTORY_TOKEN must be set.');
+const headers = { Authorization: `Bearer ${process.env.ARTIFACTORY_TOKEN}` };
+
+const validAccessLevels = [
+    'external',
+    'external-confidential',
+    'internal',
+    'internal-confidential',
+] as const;
+
+const parseOptions = () =>
+    new Command()
+        .description('Create a new source in Artifactory')
+        .requiredOption('-i, --id <id>', 'Source id, e.g. release-test')
+        .addOption(
+            new Option('-a, --access-level <access level>', 'Access level')
+                .choices(validAccessLevels)
+                .makeOptionMandatory()
+        )
+        .requiredOption('-n, --name <name>', 'Name, e.g. "Release Test"')
+        .requiredOption(
+            '-d, --description <description>',
+            'Longer description, e.g. "Versions we intend to release next"'
+        )
+        .parse()
+        .opts();
+
+type Options = ReturnType<typeof parseOptions>;
+
+const url = (opts: Options) =>
+    `https://files.nordicsemi.com/artifactory/swtools/${opts.accessLevel}/ncd/apps/${opts.id}/source.json`;
+
+const assertSourceDoesNotExist = async (opts: Options) => {
+    const get = await fetch(url(opts), { headers });
+    if (get.ok) fail(`Source ${url(opts)} already exists`);
+
+    // TODO: Check that no other source with the same name exists
+};
+
+const uploadSourceJson = async (opts: Options) => {
+    const source: SourceJson = {
+        name: opts.name,
+        description: opts.description,
+        apps: [],
+    };
+    const put = await fetch(url(opts), {
+        method: 'PUT',
+        body: JSON.stringify(source, null, 2),
+        headers,
+    });
+    if (!put.ok) fail(`Failed to upload ${url}: ${put.statusText}`);
+};
+
+const main = async () => {
+    const opts = parseOptions();
+
+    await assertSourceDoesNotExist(opts);
+    await uploadSourceJson(opts);
+};
+main();