release-please 15.4.0 → 15.5.0

package/CHANGELOG.md

@@ -4,6 +4,14 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [15.5.0](https://github.com/googleapis/release-please/compare/v15.4.0...v15.5.0) (2023-01-27)
+
+
+### Features
+
+* Add generic TOML updater ([#1833](https://github.com/googleapis/release-please/issues/1833)) ([2768a4c](https://github.com/googleapis/release-please/commit/2768a4cfe131ac8493447a8c7512c623c200df34))
+* Add toml generic updater option to extra-files schema ([#1835](https://github.com/googleapis/release-please/issues/1835)) ([9240f71](https://github.com/googleapis/release-please/commit/9240f71c21f077b240d2ce186456fb23b50dfd89))
+
 ## [15.4.0](https://github.com/googleapis/release-please/compare/v15.3.1...v15.4.0) (2023-01-26)
 
 

package/build/src/manifest.d.ts

@@ -30,7 +30,13 @@ type ExtraPomFile = {
     path: string;
     glob?: boolean;
 };
-export type ExtraFile = string | ExtraJsonFile | ExtraYamlFile | ExtraXmlFile | ExtraPomFile;
+type ExtraTomlFile = {
+    type: 'toml';
+    path: string;
+    jsonpath: string;
+    glob?: boolean;
+};
+export type ExtraFile = string | ExtraJsonFile | ExtraYamlFile | ExtraXmlFile | ExtraPomFile | ExtraTomlFile;
 /**
  * These are configurations provided to each strategy per-path.
  */

package/build/src/strategies/base.js

@@ -29,6 +29,7 @@ const generic_json_1 = require("../updaters/generic-json");
 const generic_xml_1 = require("../updaters/generic-xml");
 const pom_xml_1 = require("../updaters/java/pom-xml");
 const generic_yaml_1 = require("../updaters/generic-yaml");
+const generic_toml_1 = require("../updaters/generic-toml");
 const DEFAULT_CHANGELOG_PATH = 'CHANGELOG.md';
 /**
  * A strategy is responsible for determining which files are
@@ -222,6 +223,13 @@ class BaseStrategy {
                                 updater: new generic_yaml_1.GenericYaml(extraFile.jsonpath, version),
                             });
                             break;
+                        case 'toml':
+                            extraFileUpdates.push({
+                                path: this.addPath(path),
+                                createIfMissing: false,
+                                updater: new generic_toml_1.GenericToml(extraFile.jsonpath, version),
+                            });
+                            break;
                         case 'xml':
                             extraFileUpdates.push({
                                 path: this.addPath(path),

package/build/src/updaters/generic-toml.d.ts

@@ -0,0 +1,21 @@
+import { Updater } from '../update';
+import { Version } from '../version';
+import { Logger } from '../util/logger';
+/**
+ * Updates TOML document according to given JSONPath.
+ *
+ * Note that used parser does reformat the document and removes all comments,
+ * and converts everything to pure TOML.
+ * If you want to retain formatting, use generic updater with comment hints.
+ */
+export declare class GenericToml implements Updater {
+    readonly jsonpath: string;
+    readonly version: Version;
+    constructor(jsonpath: string, version: Version);
+    /**
+     * Given initial file contents, return updated contents.
+     * @param {string} content The initial content
+     * @returns {string} The updated content
+     */
+    updateContent(content: string, logger?: Logger): string;
+}

package/build/src/updaters/generic-toml.js

@@ -0,0 +1,61 @@
+"use strict";
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenericToml = void 0;
+const jp = require("jsonpath");
+const toml_edit_1 = require("../util/toml-edit");
+const logger_1 = require("../util/logger");
+/**
+ * Updates TOML document according to given JSONPath.
+ *
+ * Note that used parser does reformat the document and removes all comments,
+ * and converts everything to pure TOML.
+ * If you want to retain formatting, use generic updater with comment hints.
+ */
+class GenericToml {
+    constructor(jsonpath, version) {
+        this.jsonpath = jsonpath;
+        this.version = version;
+    }
+    /**
+     * Given initial file contents, return updated contents.
+     * @param {string} content The initial content
+     * @returns {string} The updated content
+     */
+    updateContent(content, logger = logger_1.logger) {
+        let data;
+        try {
+            data = (0, toml_edit_1.parseWith)(content);
+        }
+        catch (e) {
+            logger.warn('Invalid toml, cannot be parsed', e);
+            return content;
+        }
+        const paths = jp.paths(data, this.jsonpath);
+        if (!paths || paths.length === 0) {
+            logger.warn(`No entries modified in ${this.jsonpath}`);
+            return content;
+        }
+        let processed = content;
+        paths.forEach(path => {
+            if (path[0] === '$')
+                path = path.slice(1);
+            processed = (0, toml_edit_1.replaceTomlValue)(processed, path, this.version.toString());
+        });
+        return processed;
+    }
+}
+exports.GenericToml = GenericToml;
+//# sourceMappingURL=generic-toml.js.map

package/build/src/util/toml-edit.d.ts

@@ -1,3 +1,11 @@
+import { JsonMap } from '@iarna/toml';
+import * as TOMLParser from '@iarna/toml/lib/toml-parser';
+/**
+ * Parses input as TOML with the given parser
+ * @param input A string
+ * @param parserType The TOML parser to use (might be custom)
+ */
+export declare function parseWith(input: string, parserType?: typeof TOMLParser): JsonMap;
 /**
  * Given TOML input and a path to a value, attempt to replace
  * that value without modifying the formatting.
@@ -5,4 +13,4 @@
  * @param path Path to a value to replace. When replacing 'deps.tokio.version', pass ['deps', 'tokio', 'version']. The value must already exist.
  * @param newValue The value to replace the value at `path` with. Is passed through `JSON.stringify()` when replacing: strings will end up being double-quoted strings, properly escaped. Numbers will be numbers.
  */
-export declare function replaceTomlValue(input: string, path: string[], newValue: string): string;
+export declare function replaceTomlValue(input: string, path: (string | number)[], newValue: string): string;

package/build/src/util/toml-edit.js

@@ -13,7 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.replaceTomlValue = void 0;
+exports.replaceTomlValue = exports.parseWith = void 0;
 const TOMLParser = require("@iarna/toml/lib/toml-parser");
 const taggedValueMarker = Symbol('__TAGGED_VALUE');
 /**
@@ -60,11 +60,12 @@ class TaggedTOMLParser extends TOMLParser {
  * @param input A string
  * @param parserType The TOML parser to use (might be custom)
  */
-function parseWith(input, parserType) {
+function parseWith(input, parserType = TaggedTOMLParser) {
     const parser = new parserType();
     parser.parse(input);
     return parser.finish();
 }
+exports.parseWith = parseWith;
 function isTaggedValue(x) {
     if (!x) {
         return false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-please",
-  "version": "15.4.0",
+  "version": "15.5.0",
   "description": "generate release PRs based on the conventionalcommits.org spec",
   "main": "./build/src/index.js",
   "bin": "./build/src/bin/release-please.js",

package/schemas/config.json

@@ -117,12 +117,12 @@
                 "type": "string"
               },
               {
-                "description": "An extra JSON on YAML file with a targeted update via jsonpath.",
+                "description": "An extra JSON, YAML, or TOML file with a targeted update via jsonpath.",
                 "type": "object",
                 "properties": {
                   "type": {
                     "description": "The file format type.",
-                    "enum": ["json", "yaml"]
+                    "enum": ["json", "toml", "yaml"]
                   },
                   "path": {
                     "description": "The path to the file.",