release-please 13.17.1 → 13.18.0

package/CHANGELOG.md

@@ -4,6 +4,18 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [13.18.0](https://github.com/googleapis/release-please/compare/v13.17.1...v13.18.0) (2022-06-01)
+
+
+### Features
+
+* add support for generic yaml updater ([#1452](https://github.com/googleapis/release-please/issues/1452)) ([002231a](https://github.com/googleapis/release-please/commit/002231acfa49b3859a7eaee184a2b520eb6611d3))
+
+
+### Bug Fixes
+
+* fix parsing of tags with major versions higher than 9 ([#1451](https://github.com/googleapis/release-please/issues/1451)) ([5fc402a](https://github.com/googleapis/release-please/commit/5fc402ae41cd5aba4be5155f90fbc39f9369817d))
+
 ### [13.17.1](https://github.com/googleapis/release-please/compare/v13.17.0...v13.17.1) (2022-05-27)
 
 

package/build/src/manifest.d.ts

@@ -10,6 +10,11 @@ declare type ExtraJsonFile = {
     path: string;
     jsonpath: string;
 };
+declare type ExtraYamlFile = {
+    type: 'yaml';
+    path: string;
+    jsonpath: string;
+};
 declare type ExtraXmlFile = {
     type: 'xml';
     path: string;
@@ -19,7 +24,7 @@ declare type ExtraPomFile = {
     type: 'pom';
     path: string;
 };
-export declare type ExtraFile = string | ExtraJsonFile | ExtraXmlFile | ExtraPomFile;
+export declare type ExtraFile = string | ExtraJsonFile | ExtraYamlFile | ExtraXmlFile | ExtraPomFile;
 /**
  * These are configurations provided to each strategy per-path.
  */

package/build/src/strategies/base.js

@@ -29,6 +29,7 @@ const generic_1 = require("../updaters/generic");
 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 DEFAULT_CHANGELOG_PATH = 'CHANGELOG.md';
 /**
  * A strategy is responsible for determining which files are
@@ -183,6 +184,12 @@ class BaseStrategy {
                             createIfMissing: false,
                             updater: new generic_json_1.GenericJson(extraFile.jsonpath, version),
                         };
+                    case 'yaml':
+                        return {
+                            path: this.addPath(extraFile.path),
+                            createIfMissing: false,
+                            updater: new generic_yaml_1.GenericYaml(extraFile.jsonpath, version),
+                        };
                     case 'xml':
                         return {
                             path: this.addPath(extraFile.path),

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

@@ -0,0 +1,22 @@
+import { Updater } from '../update';
+import { Version } from '../version';
+/**
+ * Updates YAML document according to given JSONPath.
+ *
+ * Note that used parser does reformat the document and removes all comments,
+ * and converts everything to pure YAML (even JSON source).
+ * If you want to retain formatting, use generic updater with comment hints.
+ *
+ * When applied on multi-document file, it updates all documents.
+ */
+export declare class GenericYaml 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): string;
+}

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

@@ -0,0 +1,77 @@
+"use strict";
+// Copyright 2022 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.GenericYaml = void 0;
+const jp = require("jsonpath");
+const yaml = require("js-yaml");
+const logger_1 = require("../util/logger");
+const DOCUMENT_SEPARATOR = '---\n';
+/**
+ * Updates YAML document according to given JSONPath.
+ *
+ * Note that used parser does reformat the document and removes all comments,
+ * and converts everything to pure YAML (even JSON source).
+ * If you want to retain formatting, use generic updater with comment hints.
+ *
+ * When applied on multi-document file, it updates all documents.
+ */
+class GenericYaml {
+    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) {
+        // Parse possibly multi-document file
+        let docs;
+        try {
+            docs = yaml.loadAll(content, null, { json: true });
+        }
+        catch (e) {
+            logger_1.logger.warn('Invalid yaml, cannot be parsed', e);
+            return content;
+        }
+        // Update each document
+        let modified = false;
+        docs.forEach(data => {
+            const nodes = jp.apply(data, this.jsonpath, _val => {
+                return this.version.toString();
+            });
+            if (nodes && nodes.length) {
+                modified = true;
+            }
+        });
+        // If nothing was modified, return original content
+        if (!modified) {
+            logger_1.logger.warn(`No entries modified in ${this.jsonpath}`);
+            return content;
+        }
+        // Stringify documents
+        if (docs.length === 1) {
+            // Single doc
+            return yaml.dump(docs[0]);
+        }
+        else {
+            // Multi-document, each document starts with separator
+            return docs.map(data => DOCUMENT_SEPARATOR + yaml.dump(data)).join('');
+        }
+    }
+}
+exports.GenericYaml = GenericYaml;
+//# sourceMappingURL=generic-yaml.js.map

package/build/src/util/tag-name.js

@@ -15,7 +15,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TagName = void 0;
 const version_1 = require("../version");
-const TAG_PATTERN = /^((?<component>.*)(?<separator>[^a-zA-Z]))?(?<v>v)?(?<version>\d+\.\d+\.\d+.*)$/;
+const TAG_PATTERN = /^((?<component>.*)(?<separator>[^a-zA-Z0-9]))?(?<v>v)?(?<version>\d+\.\d+\.\d+.*)$/;
 const DEFAULT_SEPARATOR = '-';
 class TagName {
     constructor(version, component, separator = DEFAULT_SEPARATOR, includeV = true) {

package/package.json

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