@halospv3/hce.shared-config 3.4.6 → 3.4.7

package/mjs/semantic-release__github.d.mts

@@ -0,0 +1,141 @@
+//#region src/semantic-release__github.d.ts
+declare module '@semantic-release/github' {
+  /**
+   * @see https://github.com/semantic-release/github#configuration
+   */
+  export interface Env extends NodeJS.ProcessEnv {
+    /**
+     * __Required__. The token used to authenticate with GitHub.
+     */
+    GITHUB_TOKEN?: string;
+    /**
+     * {@inheritDoc GitHubEnv.GITHUB_TOKEN}
+     */
+    GH_TOKEN?: string;
+    /**
+     *  The GitHub server endpoint.
+     */
+    GITHUB_URL?: string;
+    /**
+     * {@inheritDoc GitHubEnv.GITHUB_URL}
+     */
+    GH_URL?: string;
+    /**
+     * The GitHub API prefix, relative to {@link Env.GITHUB_URL GITHUB_URL}.
+     */
+    GITHUB_PREFIX?: string;
+    /** {@inheritDoc GitHubEnv.GITHUB_PREFIX} */
+    GH_PREFIX?: string;
+    /**
+     * The GitHub API endpoint. Note that this overwrites {@link Env.GITHUB_PREFIX GITHUB_PREFIX}.
+     */
+    GITHUB_API_URL?: string;
+  }
+  /** https://github.com/isaacs/node-glob#glob-primer */
+  type Glob = string;
+  /** @see https://github.com/semantic-release/github#assets */
+  interface Asset {
+    /** __Required__. A {@link https://github.com/isaacs/node-glob#glob-primer glob} to identify the files to upload. */
+    path: Glob;
+    /**
+     * The name of the downloadable file on the GitHub release.
+     * Defaults to the file name extracted from the {@link Asset.path}.
+     */
+    name?: string;
+    /** Short description of the file displayed on the GitHub release. */
+    label?: string;
+  }
+  /** @see https://github.com/semantic-release/github#configuration */
+  export interface Options {
+    /**
+     * The GitHub server endpoint.
+     * Defaults to the values of the {@link Env.GH_URL GH_URL} or {@link Env.GITHUB_URL GITHUB_URL} environment variables.
+     */
+    githubUrl?: string;
+    /**
+     * The GitHub API prefix, relative to `githubUrl`.
+     * Defaults to the values of the {@link Env.GH_PREFIX GH_PREFIX} or {@link Env.GITHUB_PREFIX GITHUB_PREFIX} environment variables
+     */
+    githubApiPathPrefix?: string;
+    /**
+     * The GitHub API endpoint.
+     * Note that this overwrites {@link Options.githubApiPathPrefix githubApiPathPrefix}.
+     */
+    githubApiUrl?: string;
+    /**
+     * The proxy to use to access the GitHub API.
+     * Set to `false` to disable usage of proxy.
+     * See {@link https://github.com/semantic-release/github#proxy proxy}.
+     */
+    proxy?: string | false;
+    /**
+     * An array of files to upload to the release.
+     * See {@link https://github.com/semantic-release/github#assets assets}.
+     */
+    assets?: Glob | (Asset | Glob)[];
+    /**
+     * The comment to add to each issue and pull request resolved by the release.
+     * Set to `false` to disable commenting on issues and pull requests.
+     * See {@link https://github.com/semantic-release/github?tab=readme-ov-file#successcomment successComment}.
+     * Defaults to `:tada: This issue has been resolved in version ${nextRelease.version} :tada:\n\nThe release is available on [GitHub release](<github_release_url>)`
+     */
+    successComment?: string | false;
+    /**
+     * The content of the issue created when a release fails.
+     * Set to `false` to disable opening an issue when a release fails.
+     * See {@link https://github.com/semantic-release/github?tab=readme-ov-file#failcomment failComment}.
+     * Defaults to a friendly message with links to semantic-release documentation and support, with the list of errors that caused the release to fail.
+     */
+    failComment?: string | false;
+    /**
+     * The title of the issue created when a release fails.
+     * Set to `false` to disable opening an issue when a release fails.
+     * Defaults to `The automated release is failing 🚨`
+     */
+    failTitle?: string | false;
+    /**
+     * The {@link https://help.github.com/articles/about-labels labels} to add to the issue created when a release fails.
+     * Set to `false` to not add any label.
+     * @default ['semantic-release']
+     */
+    labels?: string[] | false;
+    /**
+     * The {@link https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users assignees} to add to the issue created when a release fails.
+     */
+    assignees?: unknown;
+    /**
+     *  The {@link https://help.github.com/articles/about-labels labels} to add to each issue and pull request resolved by the release.
+     * Set to `false` to not add any label.
+     * See {@link https://github.com/semantic-release/github#releasedlabels releasedLabels}.
+     * @default [ 'released<%= nextRelease.channel ? \` on @\${nextRelease.channel}\` : "" %>' ]
+     */
+    releasedLabels?: string[];
+    /**
+     * Will add release links to the GitHub Release. Can be `false`, `"bottom"` or `"top"`. See {@link https://github.com/semantic-release/github#addReleases addReleases}.
+     * @default false
+     */
+    addReleases?: false | 'bottom' | 'top';
+    /**
+     * A boolean indicating if a GitHub Draft Release should be created instead of publishing an actual GitHub Release.
+     * @default false
+     */
+    draftRelease?: boolean;
+    /**
+     * A {@link https://lodash.com/docs#template Lodash template} to customize the github release's name
+     * @default '<%= nextRelease.name %>'
+     */
+    releaseNameTemplate?: string;
+    /**
+     * A {@link https://lodash.com/docs#template Lodash template} to customize the github release's body
+     * @default '<%= nextRelease.notes %>'
+     */
+    releaseBodyTemplate?: string;
+    /**
+     * The category name in which to create a linked discussion to the release.
+     * Set to `false` to disable creating discussion for a release.
+     * @default false
+     */
+    discussionCategoryName?: string | false;
+  }
+}
+//# sourceMappingURL=semantic-release__github.d.mts.map

package/mjs/semantic-release__github.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"semantic-release__github.d.mts","names":["NodeJS","ProcessEnv","Glob","Asset","Env","GITHUB_TOKEN","GH_TOKEN","GITHUB_URL","GH_URL","GITHUB_PREFIX","GH_PREFIX","GITHUB_API_URL","path","name","label","Options","githubUrl","githubApiPathPrefix","githubApiUrl","proxy","assets","successComment","failComment","failTitle","labels","assignees","releasedLabels","addReleases","draftRelease","releaseNameTemplate","releaseBodyTemplate","discussionCategoryName","sideEffect","_0"],"sources":["../src/semantic-release__github.d.ts"],"mappings":";;;;;mBAImBI,GAAAA,SAAYJ,MAAAA,CAAOC,UAAAA;IAsC5BC;;;IAlCNG,YAAAA;IAuE6B;;;IAnE7BC,QAAAA;IAJAD;;;IASAE,UAAAA;IASAE;;;IALAD,MAAAA;IAqBAI;;;IAhBAH,aAAAA;IA2BeM;IAzBfL,SAAAA;IAwCAQ;;;IAnCAP,cAAAA;EAAAA;EAqDAU;EAAAA,KAjDGnB,IAAAA;EAoEHsB;EAAAA,UAjEQrB,KAAAA;IA4ERuB;IA1EAd,IAAAA,EAAMV,IAAAA;IAoFN0B;;;;IA/EAf,IAAAA;IA+FsBmB;IA7FtBlB,KAAAA;EAAAA;;mBAIeC,OAAAA;;;;;IAKfC,SAAAA;;;;;IAKAC,mBAAAA;;;;;IAKAC,YAAAA;;;;;;IAMAC,KAAAA;;;;;IAKAC,MAAAA,GAASlB,IAAAA,IAAQC,KAAAA,GAAQD,IAAAA;;;;;;;IAOzBmB,cAAAA;;;;;;;IAOAC,WAAAA;;;;;;IAMAC,SAAAA;;;;;;IAMAC,MAAAA;;;;IAIAC,SAAAA;;;;;;;IAOAC,cAAAA;;;;;IAKAC,WAAAA;;;;;IAKAC,YAAAA;;;;;IAKAC,mBAAAA;;;;;IAKAC,mBAAAA;;;;;;IAMAC,sBAAAA;EAAAA;AAAAA"}

package/mjs/semanticReleaseConfig.d.mts

@@ -0,0 +1,94 @@
+import { DefaultOptions } from "./setupGitPluginSpec.default.mjs";
+import { Options } from "@semantic-release/commit-analyzer";
+import { Options as Options$1 } from "@semantic-release/exec";
+import { Options as Options$2 } from "@semantic-release/git";
+import { Options as Options$3 } from "@semantic-release/github";
+import { PluginSpec } from "semantic-release";
+
+//#region src/semanticReleaseConfig.d.ts
+interface SRReleaseNotesGeneratorOptions {
+  /**
+  * conventional-changelog preset.
+  * @default 'angular'
+  */
+  preset?: "angular" | "atom" | "codemirror" | "ember" | "eslint" | "express" | "jquery" | "jscs" | "jshint" | "conventionalcommits" | (string & Record<never, never>) | undefined;
+  /**
+  * Requireable npm package with a custom conventional-changelog preset.
+  */
+  config?: string | undefined;
+  /**
+  * Additional `conventional-changelog-parser` options that will overwrite ones loaded by `preset` or `config`.
+  */
+  parserOpts: object;
+  /**
+  * Additional `conventional-changelog-writer` options that will overwrite ones loaded by `preset` or `config`.
+  */
+  writerOpts: object;
+}
+/**
+* A two-type PluginSpec to tie a plugin's name to its Options type. This is
+* intended for use by plugins to associate their Options type with their plugin
+* name.
+*/
+type PluginSpecTuple<P extends string = string, T = unknown> = [P, T];
+type PluginSpecSRCommitAnalyzer<V extends Options = Options> = PluginSpecTuple<"@semantic-release/commit-analyzer", V>;
+type PluginSpecSRChangelog<V extends Record<"changelogFile" | "changelogTitle", string>> = PluginSpecTuple<"@semantic-release/changelog", V>;
+type PluginSpecExportData<V extends Record<string, unknown> = Record<string, unknown>> = PluginSpecTuple<"semantic-release-export-data", V>;
+type PluginSpecSRReleaseNotesGen<V extends SRReleaseNotesGeneratorOptions = SRReleaseNotesGeneratorOptions> = PluginSpecTuple<"@semantic-release/release-notes-generator", V>;
+type PluginSpecSRExec<V extends Options$1 = Options$1> = PluginSpecTuple<"@semantic-release/exec", V>;
+type PluginSpecSRGit<V extends Options$2 = Options$2> = PluginSpecTuple<"@semantic-release/git", V>;
+type PluginSpecSRGithub<V extends Options$3 = Options$3> = PluginSpecTuple<"@semantic-release/github", V>;
+/**
+* @satisfies { Readonly<PluginSpec[]> }
+*/
+declare const defaultPlugins: readonly ["@semantic-release/commit-analyzer", "@semantic-release/release-notes-generator", "@semantic-release/npm", "@semantic-release/github"];
+/**
+*  @see baseConfig
+*/
+declare const _baseConfig: {
+  /** @see https://semantic-release.gitbook.io/semantic-release/usage/plugins#plugin-options-configuration */preset: "conventionalcommits";
+  branches: ["main", {
+    name: "develop";
+    channel: "develop";
+    prerelease: true;
+  }];
+  plugins: [PluginSpecSRCommitAnalyzer, PluginSpecExportData, PluginSpecSRReleaseNotesGen, PluginSpecSRChangelog<Record<"changelogFile" | "changelogTitle", string>>, PluginSpecSRGit<typeof DefaultOptions>, PluginSpecSRExec, PluginSpecSRGithub<{
+    addReleases: "bottom";
+    assets: [{
+      path: "./publish/*";
+    }];
+  }>] | Exclude<PluginSpec, string>[];
+};
+/**
+* The base configuration for various Semantic Release scenarios.
+* - Prefers preset "conventionalcommits"
+*   (Conventional-Changelog-ConventionalCommits).
+* - Creates tags and release commits on "main" branch, pre-releases on
+*   "develop" branch in "develop" channel.
+* - Creates GitHub Releases.
+* - Exports the following variables as GitHub Actions outputs:
+*   - "new-release-published": "true" | "false"
+*   - "new-release-version" : string
+*   - "new-release-git-tag" : string
+* - includes default plugins (except `@semantic-release/npm`) and more
+*   - `@semantic-release/commit-analyzer`
+*   - semantic-release-export-data
+*   - `@semantic-release/release-notes-generator`
+*   - `@semantic-release/changelog`
+*   - `@semantic-release/git`
+*     - add modified CHANGELOG.md in release commit
+*   - `@semantic-release/exec`
+*     - does nothing by default. Included for convenience.
+*   - `@semantic-release/github`
+*     - uploads all files from `./publish/*`. This is non-recursive.
+*     - adds a list of links to related release pages (e.g. the release's page on npmjs.com)
+*
+* (OPTIONAL) update static Version strings before Git plugin
+* - https://github.com/jpoehnelt/semantic-release-replace-plugin
+* - https://github.com/droidsolutions/semantic-release-update-file
+* @satisfies {Options}
+*/
+declare const baseConfig: typeof _baseConfig;
+//#endregion
+export { PluginSpecExportData, PluginSpecSRChangelog, PluginSpecSRCommitAnalyzer, PluginSpecSRExec, PluginSpecSRGit, PluginSpecSRGithub, PluginSpecSRReleaseNotesGen, PluginSpecTuple, SRReleaseNotesGeneratorOptions, baseConfig, defaultPlugins };
+//# sourceMappingURL=semanticReleaseConfig.d.mts.map

package/mjs/semanticReleaseConfig.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"semanticReleaseConfig.d.mts","names":[],"sources":["../src/semanticReleaseConfig.ts"],"mappings":";;;;;;;;UAWiB,8BAAA;;AAAjB;;;EAKE,MAAA,yIAA+I,MAAA;;;;EAI/I,MAAA;;;;EAIA,UAAA;EAYU;;;EARV,UAAA;AAAA;;;;;AASF;KADY,eAAA,4CAA2D,CAAA,EAAG,CAAA;AAAA,KAC9D,0BAAA,WAAqC,OAAA,GAA0B,OAAA,IAA2B,eAAA,sCAAqD,CAAA;AAAA,KAC/I,qBAAA,WAAgC,MAAA,gDAAsD,eAAA,gCAA+C,CAAA;AAAA,KACrI,oBAAA,WAA+B,MAAA,oBAA0B,MAAA,qBAA2B,eAAA,iCAAgD,CAAA;AAAA,KACpI,2BAAA,WAAsC,8BAAA,GAAiC,8BAAA,IAAkC,eAAA,8CAA6D,CAAA;AAAA,KACtK,gBAAA,WAA2B,SAAA,GAAgB,SAAA,IAAiB,eAAA,2BAA0C,CAAA;AAAA,KACtG,eAAA,WAA0B,SAAA,GAAe,SAAA,IAAgB,eAAA,0BAAyC,CAAA;AAAA,KAClG,kBAAA,WAA6B,SAAA,GAAkB,SAAA,IAAmB,eAAA,6BAA4C,CAAA;;;;cAK7G,cAAA;AAVb;;;AAAA,cA0BM,WAAA;6GAEJ,MAAA;EACA,QAAA;IAGgB,IAAA;IAAiB,OAAA;IAAoB,UAAA;EAAA;EACrD,OAAA,GASE,0BAAA,EACA,oBAAA,EACA,2BAAA,EACA,qBAAA,CAAsB,MAAA,+CACtB,eAAA,QAAuB,cAAA,GACvB,gBAAA,EACA,kBAAA;IAAqB,WAAA;IAAuB,MAAA;MAAW,IAAA;IAAA;EAAA,MACrD,OAAA,CAAQ,UAAA;AAAA;;;;;;;;;;;;;AA/Cd;;;;;;;;;;;;;;;;AACA;cA8Ea,UAAA,SAAmB,WAAA"}

package/mjs/semanticReleaseConfig.mjs

@@ -1,63 +1,2 @@
-import { DefaultOptions } from './setupGitPluginSpec.mjs';
-
-/**
- * A two-type PluginSpec to tie a plugin's name to its Options type. This is
- * intended for use by plugins to associate their Options type with their plugin
- * name.
- */
-
-/**
- * @satisfies { Readonly<PluginSpec[]> }
- */
-const defaultPlugins = Object.freeze(['@semantic-release/commit-analyzer', '@semantic-release/release-notes-generator', '@semantic-release/npm', '@semantic-release/github']);
-
-// define as const for string literals in type, then...
-/**
- *  @see baseConfig
- */
-const _baseConfig = {
-  /** @see https://semantic-release.gitbook.io/semantic-release/usage/plugins#plugin-options-configuration */
-  preset: 'conventionalcommits',
-  branches: ['main', {
-    name: 'develop',
-    channel: 'develop',
-    prerelease: true
-  }],
-  plugins: [['@semantic-release/commit-analyzer', {}], ['semantic-release-export-data', {}], ['@semantic-release/release-notes-generator', {}], ['@semantic-release/changelog', {}], ['@semantic-release/git', DefaultOptions], ['@semantic-release/exec', {}], ['@semantic-release/github', {
-    addReleases: 'bottom',
-    assets: ['./publish/*', '!./publish/.gitkeep']
-  }]]
-};
-
-/**
- * The base configuration for various Semantic Release scenarios.
- * - Prefers preset "conventionalcommits"
- *   (Conventional-Changelog-ConventionalCommits).
- * - Creates tags and release commits on "main" branch, pre-releases on
- *   "develop" branch in "develop" channel.
- * - Creates GitHub Releases.
- * - Exports the following variables as GitHub Actions outputs:
- *   - "new-release-published": "true" | "false"
- *   - "new-release-version" : string
- *   - "new-release-git-tag" : string
- * - includes default plugins (except `@semantic-release/npm`) and more
- *   - `@semantic-release/commit-analyzer`
- *   - semantic-release-export-data
- *   - `@semantic-release/release-notes-generator`
- *   - `@semantic-release/changelog`
- *   - `@semantic-release/git`
- *     - add modified CHANGELOG.md in release commit
- *   - `@semantic-release/exec`
- *     - does nothing by default. Included for convenience.
- *   - `@semantic-release/github`
- *     - uploads all files from `./publish/*`. This is non-recursive.
- *     - adds a list of links to related release pages (e.g. the release's page on npmjs.com)
- *
- * (OPTIONAL) update static Version strings before Git plugin
- * - https://github.com/jpoehnelt/semantic-release-replace-plugin
- * - https://github.com/droidsolutions/semantic-release-update-file
- * @satisfies {Options}
- */
-const baseConfig = _baseConfig;
-export { baseConfig, defaultPlugins };
-//# sourceMappingURL=semanticReleaseConfig.mjs.map
+import{DefaultOptions as e}from"./setupGitPluginSpec.default.mjs";const t=Object.freeze([`@semantic-release/commit-analyzer`,`@semantic-release/release-notes-generator`,`@semantic-release/npm`,`@semantic-release/github`]),n={preset:`conventionalcommits`,branches:[`main`,{name:`develop`,channel:`develop`,prerelease:!0}],plugins:[[`@semantic-release/commit-analyzer`,{}],[`semantic-release-export-data`,{}],[`@semantic-release/release-notes-generator`,{}],[`@semantic-release/changelog`,{}],[`@semantic-release/git`,e],[`@semantic-release/exec`,{}],[`@semantic-release/github`,{addReleases:`bottom`,assets:[`./publish/*`,`!./publish/.gitkeep`]}]]};export{n as baseConfig,t as defaultPlugins};
+//# sourceMappingURL=semanticReleaseConfig.mjs.map

package/mjs/semanticReleaseConfig.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"semanticReleaseConfig.mjs","sources":["../src/semanticReleaseConfig.ts"],"names":[],"mappings":";;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACY,MAAC,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,mCAAmC,EAAE,2CAA2C,EAAE,uBAAuB,EAAE,0BAA0B,CAAC;;AAEnL;AACA;AACA;AACA;AACA,MAAM,WAAW,GAAG;AACpB;AACA,EAAE,MAAM,EAAE,qBAAqB;AAC/B,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE;AACrB,IAAI,IAAI,EAAE,SAAS;AACnB,IAAI,OAAO,EAAE,SAAS;AACtB,IAAI,UAAU,EAAE;AAChB,GAAG,CAAC;AACJ,EAAE,OAAO,EAAE,CAAC,CAAC,mCAAmC,EAAE,EAAE,CAAC,EAAE,CAAC,8BAA8B,EAAE,EAAE,CAAC,EAAE,CAAC,2CAA2C,EAAE,EAAE,CAAC,EAAE,CAAC,6BAA6B,EAAE,EAAE,CAAC,EAAE,CAAC,uBAAuB,EAAE,cAAc,CAAC,EAAE,CAAC,wBAAwB,EAAE,EAAE,CAAC,EAAE,CAAC,0BAA0B,EAAE;AAC7R,IAAI,WAAW,EAAE,QAAQ;AACzB,IAAI,MAAM,EAAE,CAAC,aAAa,EAAE,qBAAqB;AACjD,GAAG,CAAC;AACJ,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACY,MAAC,UAAU,GAAG;;;;"}
+{"version":3,"file":"semanticReleaseConfig.mjs","names":[],"sources":["../src/semanticReleaseConfig.ts"],"sourcesContent":["// @ts-types=\"./semantic-release__commit-analyzer.d.ts\"\nimport type { Options as SRCommitAnalyzerOptions } from '@semantic-release/commit-analyzer';\n// @ts-types=\"./semantic-release__exec.d.ts\"\nimport type { Options as SRExecOptions } from '@semantic-release/exec';\n// @ts-types=\"./semantic-release__git.d.ts\"\nimport type { Options as SRGitOptions } from '@semantic-release/git';\n// @ts-types=\"./semantic-release__github.d.ts\"\nimport type { Options as SRGithubOptions } from '@semantic-release/github';\nimport type { Options, PluginSpec } from 'semantic-release';\nimport { DefaultOptions } from './setupGitPluginSpec.default.ts';\n\nexport interface SRReleaseNotesGeneratorOptions {\n  /**\n   * conventional-changelog preset.\n   * @default 'angular'\n   */\n  preset?: 'angular' | 'atom' | 'codemirror' | 'ember' | 'eslint' | 'express' | 'jquery' | 'jscs' | 'jshint' | 'conventionalcommits' | (string & Record<never, never>) | undefined;\n  /**\n   * Requireable npm package with a custom conventional-changelog preset.\n   */\n  config?: string | undefined;\n  /**\n   * Additional `conventional-changelog-parser` options that will overwrite ones loaded by `preset` or `config`.\n   */\n  parserOpts: object;\n  /**\n   * Additional `conventional-changelog-writer` options that will overwrite ones loaded by `preset` or `config`.\n   */\n  writerOpts: object;\n}\n\n/**\n * A two-type PluginSpec to tie a plugin's name to its Options type. This is\n * intended for use by plugins to associate their Options type with their plugin\n * name.\n */\nexport type PluginSpecTuple<P extends string = string, T = unknown> = [P, T];\nexport type PluginSpecSRCommitAnalyzer<V extends SRCommitAnalyzerOptions = SRCommitAnalyzerOptions> = PluginSpecTuple<'@semantic-release/commit-analyzer', V>;\nexport type PluginSpecSRChangelog<V extends Record<'changelogFile' | 'changelogTitle', string>> = PluginSpecTuple<'@semantic-release/changelog', V>;\nexport type PluginSpecExportData<V extends Record<string, unknown> = Record<string, unknown>> = PluginSpecTuple<'semantic-release-export-data', V>;\nexport type PluginSpecSRReleaseNotesGen<V extends SRReleaseNotesGeneratorOptions = SRReleaseNotesGeneratorOptions> = PluginSpecTuple<'@semantic-release/release-notes-generator', V>;\nexport type PluginSpecSRExec<V extends SRExecOptions = SRExecOptions> = PluginSpecTuple<'@semantic-release/exec', V>;\nexport type PluginSpecSRGit<V extends SRGitOptions = SRGitOptions> = PluginSpecTuple<'@semantic-release/git', V>;\nexport type PluginSpecSRGithub<V extends SRGithubOptions = SRGithubOptions> = PluginSpecTuple<'@semantic-release/github', V>;\n\n/**\n * @satisfies { Readonly<PluginSpec[]> }\n */\nexport const defaultPlugins: readonly [\n  '@semantic-release/commit-analyzer',\n  '@semantic-release/release-notes-generator',\n  '@semantic-release/npm',\n  '@semantic-release/github',\n] = Object.freeze([\n  '@semantic-release/commit-analyzer',\n  '@semantic-release/release-notes-generator',\n  '@semantic-release/npm',\n  '@semantic-release/github',\n] as const) satisfies readonly PluginSpec[];\n\n// define as const for string literals in type, then...\n/**\n *  @see baseConfig\n */\nconst _baseConfig = {\n  /** @see https://semantic-release.gitbook.io/semantic-release/usage/plugins#plugin-options-configuration */\n  preset: 'conventionalcommits' as const,\n  branches: [\n    'main',\n    { name: 'develop', channel: 'develop', prerelease: true },\n  ] as ['main', { name: 'develop'; channel: 'develop'; prerelease: true }],\n  plugins: [\n    ['@semantic-release/commit-analyzer', {}],\n    ['semantic-release-export-data', {}],\n    ['@semantic-release/release-notes-generator', {}],\n    ['@semantic-release/changelog', {}],\n    ['@semantic-release/git', DefaultOptions],\n    ['@semantic-release/exec', {}],\n    ['@semantic-release/github', { addReleases: 'bottom', assets: ['./publish/*', '!./publish/.gitkeep'] }],\n  ] as [\n    PluginSpecSRCommitAnalyzer,\n    PluginSpecExportData,\n    PluginSpecSRReleaseNotesGen,\n    PluginSpecSRChangelog<Record<'changelogFile' | 'changelogTitle', string>>,\n    PluginSpecSRGit<typeof DefaultOptions>,\n    PluginSpecSRExec,\n    PluginSpecSRGithub<{ addReleases: 'bottom'; assets: [{ path: './publish/*' }] }>,\n  ] | Exclude<PluginSpec, string>[],\n};\n\n/**\n * The base configuration for various Semantic Release scenarios.\n * - Prefers preset \"conventionalcommits\"\n *   (Conventional-Changelog-ConventionalCommits).\n * - Creates tags and release commits on \"main\" branch, pre-releases on\n *   \"develop\" branch in \"develop\" channel.\n * - Creates GitHub Releases.\n * - Exports the following variables as GitHub Actions outputs:\n *   - \"new-release-published\": \"true\" | \"false\"\n *   - \"new-release-version\" : string\n *   - \"new-release-git-tag\" : string\n * - includes default plugins (except `@semantic-release/npm`) and more\n *   - `@semantic-release/commit-analyzer`\n *   - semantic-release-export-data\n *   - `@semantic-release/release-notes-generator`\n *   - `@semantic-release/changelog`\n *   - `@semantic-release/git`\n *     - add modified CHANGELOG.md in release commit\n *   - `@semantic-release/exec`\n *     - does nothing by default. Included for convenience.\n *   - `@semantic-release/github`\n *     - uploads all files from `./publish/*`. This is non-recursive.\n *     - adds a list of links to related release pages (e.g. the release's page on npmjs.com)\n *\n * (OPTIONAL) update static Version strings before Git plugin\n * - https://github.com/jpoehnelt/semantic-release-replace-plugin\n * - https://github.com/droidsolutions/semantic-release-update-file\n * @satisfies {Options}\n */\nexport const baseConfig: typeof _baseConfig = _baseConfig satisfies Options;\n"],"mappings":"kEAgDA,MAAa,EAKT,OAAO,OAAO,CAChB,oCACA,4CACA,wBACA,2BACD,CAAU,CA6DE,EAvDO,CAElB,OAAQ,sBACR,SAAU,CACR,OACA,CAAE,KAAM,UAAW,QAAS,UAAW,WAAY,GAAM,CAC1D,CACD,QAAS,CACP,CAAC,oCAAqC,EAAE,CAAC,CACzC,CAAC,+BAAgC,EAAE,CAAC,CACpC,CAAC,4CAA6C,EAAE,CAAC,CACjD,CAAC,8BAA+B,EAAE,CAAC,CACnC,CAAC,wBAAyB,EAAe,CACzC,CAAC,yBAA0B,EAAE,CAAC,CAC9B,CAAC,2BAA4B,CAAE,YAAa,SAAU,OAAQ,CAAC,cAAe,sBAAsB,CAAE,CAAC,CACxG,CASF"}

package/mjs/semanticReleaseConfigDotnet.d.mts

@@ -0,0 +1,96 @@
+import { MSBuildProject } from "./dotnet/MSBuildProject.mjs";
+import { NugetRegistryInfo } from "./dotnet/NugetRegistryInfo.mjs";
+import { Options } from "semantic-release";
+
+//#region src/semanticReleaseConfigDotnet.d.ts
+declare class SemanticReleaseConfigDotnet {
+  private readonly options;
+  private readonly _projectsToPublish;
+  private _projectsToPackAndPush;
+  private readonly _evaluatedProjects;
+  /**
+  * Creates an instance of SemanticReleaseConfigDotnet.
+  * Configures {@link baseConfig} with `@semantic-release/exec` to `dotnet` publish, pack, and push.
+  *
+  * Note: To sign packages, create a Target in the corresponding project(s) e.g.
+  * ```xml
+  * <Target Name="SignNupkgs" AfterTargets="Pack">
+  *   <Exec Command="dotnet nuget sign $(PackageOutputPath) [remaining args]" ConsoleToMsBuild="true" />
+  * </Target>
+  * ```
+  * Alternatively, splice your signing commands into the publishCmd string,
+  * inserting them before `dotnet nuget push`.
+  * If you sign different signatures depending on the NuGet registry,
+  * splice your signing command (with "overwrite signature" enabled, if
+  * desired) before the corresponding registry's `dotnet nuget push` command.
+  * @param projectsToPublish An array of dotnet projects' relative paths. If
+  * empty or unspecified, tries getting projects' semi-colon-separated relative
+  * paths from the `PROJECTS_TO_PUBLISH` environment variable. If configured as
+  * recommended, the projects' publish outputs will be zipped to '$PWD/publish'
+  * for use in the `publish` semantic-release step (typically, GitHub release).
+  * @param projectsToPackAndPush An array of dotnet projects' relative paths.
+  * If empty or unspecified, tries getting projects' semi-colon-separated
+  * relative paths from the `PROJECTS_TO_PACK_AND_PUSH` environment variable.
+  * Otherwise, no packages will be packed and pushed.
+  * If configured as recommended, `dotnet pack` will output the nupkg/snupkg
+  * files to `$PWD/publish` where they will be globbed by `dotnet nuget push`.
+  */
+  constructor(projectsToPublish: string[] | MSBuildProject[], projectsToPackAndPush: string[] | NugetRegistryInfo[]);
+  get ProjectsToPublish(): string[] | MSBuildProject[];
+  get ProjectsToPackAndPush(): string[] | NugetRegistryInfo[];
+  get EvaluatedProjects(): MSBuildProject[];
+  /** @deprecated Superseded by {@link splicePlugin} */
+  insertPlugin(afterPluginsIDs: string[], insertPluginIDs: string[], beforePluginsIDs: string[]): void;
+  /**
+  * generate dotnet commands for \@semantic-release/exec, appending commands with ' && ' when necessary.
+  *
+  * Note: All strings in {@link this.ProjectsToPackAndPush} will be converted to basic {@link NugetRegistryInfo} instances with default values.
+  * If you need specific NRI settings or you need to push to GitLab-like or GitHub-like registries, instantiate them instead of passing their paths.
+  * @todo change to builder method? e.g. static async SetupDotnetCommands(this: SemanticReleaseConfigDotnet): Promise<SemanticReleaseConfigDotnet>
+  * @todo Add options param to allow users to enable pushing to GitLab, GitHub, NuGet.org with default settings -OR- with entirely custom settings.
+  * @see https://github.com/semantic-release/exec#usage
+  */
+  setupDotnetCommands(): Promise<void>;
+  /**
+  * Insert a plugin into the plugins array.
+  * @param insertAfterPluginIDs Plugins which should appear BEFORE
+  * {@link insertPluginIDs}.
+  * @param insertPluginIDs The plugin(s) to insert into the plugins array.
+  * @param insertBeforePluginsIDs plugins which should appear AFTER the
+  * inserted plugin(s).
+  */
+  splicePlugin(insertAfterPluginIDs: string[], insertPluginIDs: string[], insertBeforePluginsIDs: string[]): void;
+  protected getTokenTestingCommands(): Promise<string>;
+  toOptions(): Options;
+}
+/**
+* Configures {@link baseConfig} with `@semantic-release/exec` to `dotnet`
+* publish, pack, and nuget-push.
+* @param projectsToPublish
+* An array of dotnet projects' relative paths -OR- an array of
+* {@link MSBuildProject} instances.
+* - If `MSBuildProject[]`, the instances will be used as-is.
+* - If `[]`, tries getting projects' semi-colon-separated relative paths from
+*   the `PROJECTS_TO_PUBLISH` environment variable.
+* - If configured as recommended, the projects' publish outputs will be zipped
+*   to '$PWD/publish' for use in the `publish` semantic-release step e.g. for a
+*   GitHub release.
+* @param projectsToPackAndPush An array of dotnet projects' relative paths -OR-
+* an array of instances of {@link NugetRegistryInfo} and/or derived classes.
+* - If `NugetRegistryInfo[]`, no conversions or modifications will occur.
+* - If `string[]`, the project paths will be converted to
+* {@link NugetRegistryInfo} instances with default values. This may be undesired.
+* - If `[]`, `dotnet pack` and `dotnet nuget push` commands will not be configured.
+* - If `undefined`, tries getting projects' semi-colon-separated relative paths
+* from the `PROJECTS_TO_PACK_AND_PUSH` environment variable.
+* With the recommended configuration, `dotnet pack` will write the nupkg/snupkg
+* files to `$PWD/publish` where they will be globbed by `dotnet nuget push`.
+* @returns a semantic-release Options object, based on
+* `@halospv3/hce.shared-config` (our base config), with the
+* `@semantic-release/exec` plugin configured to `dotnet publish`, `pack`, and
+* `push` the specified projects.
+*/
+declare function getConfig(projectsToPublish: string[] | MSBuildProject[], projectsToPackAndPush?: string[] | NugetRegistryInfo[]): Promise<Options>;
+//#endregion
+export { SemanticReleaseConfigDotnet, getConfig };
+//# sourceMappingURL=semanticReleaseConfigDotnet.d.mts.map

package/mjs/semanticReleaseConfigDotnet.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"semanticReleaseConfigDotnet.d.mts","names":[],"sources":["../src/semanticReleaseConfigDotnet.ts"],"mappings":";;;;;cAoCa,2BAAA;EAAA,iBACM,OAAA;EAAA,iBACA,kBAAA;EAAA,QACT,sBAAA;EAAA,iBACS,kBAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA6BjB,WAAA,CACE,iBAAA,aAA8B,cAAA,IAC9B,qBAAA,aAAkC,iBAAA;EAAA,IAwChC,iBAAA,CAAA,cAAgC,cAAA;EAAA,IAIhC,qBAAA,CAAA,cAAoC,iBAAA;EAAA,IAIpC,iBAAA,CAAA,GAAqB,cAAA;;EAMzB,YAAA,CACE,eAAA,YACA,eAAA,YACA,gBAAA;;;;;;;;;AA6OJ;EA/NE,mBAAA,CAAA,GAA6B,OAAA;;;;;;;;;EAmG7B,YAAA,CACE,oBAAA,YACA,eAAA,YACA,sBAAA;EAAA,UAoDc,uBAAA,CAAA,GAA2B,OAAA;EAqC3C,SAAA,CAAA,GAAa,OAAA;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAgCO,SAAA,CACpB,iBAAA,aAA8B,cAAA,IAC9B,qBAAA,cAAmC,iBAAA,KAClC,OAAA,CAAQ,OAAA"}