repository-provider 26.1.3 → 26.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repository-provider",
-  "version": "26.1.3",
+  "version": "26.2.0",
   "publishConfig": {
     "access": "public"
   },
@@ -36,9 +36,9 @@
     "ava": "^4.0.1",
     "c8": "^7.11.0",
     "documentation": "^13.2.5",
-    "repository-provider-test-support": "^1.9.6",
-    "semantic-release": "^18.0.1",
-    "typescript": "^4.6.0-dev.20220115"
+    "repository-provider-test-support": "^1.9.8",
+    "semantic-release": "^19.0.2",
+    "typescript": "^4.6.0-dev.20220124"
   },
   "engines": {
     "node": ">=14.18.3"

package/src/base-provider.mjs

@@ -482,6 +482,13 @@ export class BaseProvider {
     return Branch;
   }
 
+  /**
+   * @return {Class} branch class used by the Provider
+   */
+  get tagClass() {
+    return Tag;
+  }
+
   /**
    * @return {Class} entry class used by the Provider
    */

package/src/branch.mjs

@@ -82,6 +82,7 @@ export class Branch extends Ref {
    * @param {boolean} options.dry do not create a branch and do not commit only create dummy PR
    * @param {boolean} options.skipWithoutCommits do not create a PR if no commits are given
    * @param {boolean} options.bodyFromCommitMessages generate body from commit messages
+   * @param {string} [options.body] body of the PR
    * @return {Promise<PullRequest>}
    */
   async commitIntoPullRequest(commits, options) {

package/src/repository-group.mjs

@@ -77,6 +77,14 @@ export class RepositoryGroup extends RepositoryOwner(NamedObject) {
     return this.provider.branchClass;
   }
 
+  /**
+   * By default we use the providers implementation.
+   * @return {Class} as defined in the provider
+   */
+  get tagClass() {
+    return this.provider.branchClass;
+  }
+
   /**
    * By default we use the providers implementation.
    * @return {Class} as defined in the provider

package/src/repository.mjs

@@ -42,7 +42,7 @@ export class Repository extends NamedObject {
        * URLs of the repository
        * @return {string[]}
        */
-      urls: { },
+      urls: {},
 
       cloneURL: { type: "url" },
 
@@ -229,6 +229,14 @@ export class Repository extends NamedObject {
     return false;
   }
 
+  /**
+   * Lookup the default branch.
+   * @return {Promise<Branch>} branch named after defaultBranchName
+   */
+  get defaultBranch() {
+    return this.branch(this.defaultBranchName);
+  }
+
   /**
    * Lookup branch by name.
    * @param {string} name
@@ -239,14 +247,6 @@ export class Repository extends NamedObject {
     return this._branches.get(name);
   }
 
-  /**
-   * Lookup the default branch.
-   * @return {Promise<Branch>} branch named after defaultBranchName
-   */
-  get defaultBranch() {
-    return this.branch(this.defaultBranchName);
-  }
-
   /**
    * @return {AsyncIterator<Branch>} of all branches
    */
@@ -274,7 +274,7 @@ export class Repository extends NamedObject {
    * Internal branch creation does not call repository.initialize()
    * @param {string} name of the new branch
    * @param {Object} options
-   * @return {Promise<Branch>} newly created branch
+   * @return {Branch} newly created branch
    */
   addBranch(name, options) {
     let branch = this._branches.get(name);
@@ -298,8 +298,14 @@ export class Repository extends NamedObject {
     this._branches.delete(name);
   }
 
-  _addTag(tag) {
-    this._tags.set(tag.name, tag);
+  /**
+   * Get a Tag.
+   * @param {string} name
+   * @return {Promise<Tag>}
+   */
+  async tag(name) {
+    await this.initializeTags();
+    return this._tags.get(name);
   }
 
   /**
@@ -315,13 +321,23 @@ export class Repository extends NamedObject {
   }
 
   /**
-   * Get a Tag.
-   * @param {string} name
-   * @return {Promise<Tag>}
+   * Add a new {@link Tag}.
+   * Internal tag creation does not call repository.initialize()
+   * @param {string} name of the new tag
+   * @param {Object} options
+   * @return {Tag} newly created tag
    */
-  async tag(name) {
-    await this.initializeTags();
-    return this._tags.get(name);
+  addTag(name, options) {
+    let tag = this._tags.get(name);
+    if (tag === undefined) {
+      tag = new this.tagClass(this, name, options);
+    }
+
+    return tag;
+  }
+
+  _addTag(tag) {
+    this._tags.set(tag.name, tag);
   }
 
   /**
@@ -498,6 +514,14 @@ export class Repository extends NamedObject {
     return this.owner.branchClass;
   }
 
+  /**
+   * By default we use the owners implementation.
+   * @return {Class} as defined in the owner
+   */
+  get tagClass() {
+    return this.owner.tagClass;
+  }
+
   /**
    * By default we use the owners implementation.
    * @return {Class} as defined in the owner