✨ feat: add github config

Author: arvinxx

packages/release-config/src/createConfig.ts

@@ -3,6 +3,7 @@ import type { Options as SemRelOptions, PluginSpec } from 'semantic-release';
 import type { Options } from './type';
 import commitAnalyzer from './plugins/commitAnalyzer';
 import git from './plugins/git';
+import github from './plugins/github';
 import npm from './plugins/npm';
 
 export type { ReleaseRule, Options } from './type';
@@ -15,6 +16,36 @@ export const createConfig = (options?: Options): SemRelOptions => {
     enableGithub: true,
     ...options,
   };
+  //  npm config
+  const { npmPublish, pkgRoot, tarballDir } = opts;
+  const npmConfig = npm({ npmPublish, pkgRoot, tarballDir });
+
+  // github config
+  const {
+    githubUrl,
+    proxy,
+    releasedLabels,
+    failTitle,
+    githubApiPathPrefix,
+    labels,
+    failComment,
+    assignees,
+    addReleases,
+    githubAssets,
+  } = opts;
+  const githubConfig = github({
+    githubUrl,
+    proxy,
+    releasedLabels,
+    failTitle,
+    githubApiPathPrefix,
+    labels,
+    failComment,
+    assignees,
+    addReleases,
+    githubAssets,
+  });
+
   const plugins: PluginSpec[] = [
     /* 负责解析 commit */
     commitAnalyzer(opts.releaseRules),
@@ -34,9 +65,9 @@ export const createConfig = (options?: Options): SemRelOptions => {
       },
     ],
     /* 自动更新版本号 如果没有 private ,会作为 npm 模块进行发布 */
-    opts.enableNPM ? npm(options) : '',
+    opts.enableNPM ? npmConfig : '',
     /* 将生成结果发布到 Github */
-    opts.enableGithub ? '@semantic-release/github' : '',
+    opts.enableGithub ? githubConfig : '',
     /* 推送代码回到 Git */
     git(options),
   ];

packages/release-config/src/plugins/git.test.ts

@@ -14,7 +14,7 @@ describe('git', () => {
   });
 
   it('add new assets rules', () => {
-    expect(git({ assets: ['file.json'] })).toEqual([
+    expect(git({ gitAssets: ['file.json'] })).toEqual([
       '@semantic-release/git',
       {
         assets: ['CHANGELOG.md', 'package.json', 'file.json'],

packages/release-config/src/plugins/git.ts

@@ -10,15 +10,15 @@ const git = (options: GitPluginOpts = {}): PluginSpec => {
     '@semantic-release/git',
     {
       assets:
-        typeof options.assets === 'boolean'
+        typeof options.gitAssets === 'boolean'
           ? false
           : [
               // 这里的 assets 配置的是要重新 push 回去的东西
               // 如果不列的话会将全部内容都合并到 release 中
               'CHANGELOG.md',
               'package.json',
             ]
-              .concat(options.assets)
+              .concat(options.gitAssets)
               .filter((a) => a),
       message: options.message
         ? options.message

packages/release-config/src/plugins/github.test.ts

@@ -0,0 +1,16 @@
+import github from './github';
+
+describe('github', () => {
+  it('default', () => {
+    expect(github()).toEqual('@semantic-release/github');
+  });
+
+  it('add release assets', () => {
+    expect(github({ githubAssets: ['release'] })).toEqual([
+      '@semantic-release/github',
+      {
+        assets: ['release'],
+      },
+    ]);
+  });
+});

packages/release-config/src/plugins/github.ts

@@ -0,0 +1,25 @@
+import type { PluginSpec } from 'semantic-release';
+import type { GithubPluginOpts } from '../type';
+
+/**
+ * github
+ * @param options
+ */
+const github = (options: GithubPluginOpts = {}): PluginSpec => {
+  const noOpts =
+    options &&
+    Object.values(options).filter((i) => typeof i !== 'undefined').length === 0;
+
+  if (!options || noOpts) return '@semantic-release/github';
+
+  const { githubAssets, ...config } = options;
+  return [
+    '@semantic-release/github',
+    {
+      assets: githubAssets,
+      ...config,
+    },
+  ];
+};
+
+export default github;

packages/release-config/src/plugins/npm.ts

@@ -10,8 +10,8 @@ const npm = (options?: NPMPluginOpts): PluginSpec => {
       typeof options.tarballDir === 'undefined')
   )
     return '@semantic-release/npm';
-  const { npmPublish, pkgRoot, tarballDir } = options;
-  return ['@semantic-release/npm', { npmPublish, pkgRoot, tarballDir }];
+
+  return ['@semantic-release/npm', options];
 };
 
 export default npm;

packages/release-config/src/type.ts

@@ -6,7 +6,10 @@ export interface ReleaseRule {
   release: Release['type'];
 }
 
-export interface Options extends GitPluginOpts, NPMPluginOpts {
+export interface Options
+  extends GitPluginOpts,
+    NPMPluginOpts,
+    GithubPluginOpts {
   releaseRules?: ReleaseRule[];
   changelogTitle?: string;
   changelogFile?: string;
@@ -33,7 +36,67 @@ export interface GitPluginOpts {
    * Set to `false` to disable adding files to the release commit. See [assets](#assets).
    * @default ['CHANGELOG.md', 'package.json']
    */
-  assets?: string[] | false;
+  gitAssets?: string[] | false;
+}
+
+export interface GithubPluginOpts {
+  /**
+   * The GitHub Enterprise endpoint.
+   * @default `GH_URL` or `GITHUB_URL` environment variable.
+   */
+  githubUrl?: string;
+  /**
+   * The GitHub Enterprise API prefix.
+   * @default  `GH_PREFIX` or `GITHUB_PREFIX` environment variable.
+   */
+  githubApiPathPrefix?: string;
+  /**
+   * An array of files to upload to the release. See [assets](#assets).
+   * @default -
+   */
+  githubAssets?: string[];
+  /**
+   * The proxy to use to access the GitHub API. See [proxy](#proxy).
+   * @default   `HTTP_PROXY` environment variable.
+   */
+  proxy?: string;
+  /**
+   * 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 [successComment](#successcomment).
+   * @default `:tada: This issue has been resolved in version ${nextRelease.version} :tada:\n\nThe release is available on [GitHub release](<github_release_url>)`
+   */
+  successComment?: string;
+  /**
+   * The content of the issue created when a release fails. Set to `false` to disable opening an issue when a release fails. See [failComment](#failcomment).
+   * Friendly message with links to **semantic-release** documentation and support, with the list of errors that caused the release to fail.
+   */
+  failComment?: string;
+  /**
+   * The title of the issue created when a release fails. Set to `false` to disable opening an issue when a release fails.
+   * @default `The automated release is failing 🚨`
+   */
+  failTitle?: string;
+  /**
+   * The [labels](https://help.github.com/articles/about-labels) to add to the issue created when a release fails. Set to `false` to not add any label.
+   * @default `['semantic-release']`
+   */
+  labels?: string[];
+
+  /**
+   * The [assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users) to add to the issue created when a release fails.
+   *
+   */
+  assignees?: string[];
+  /**
+   The [labels](https://help.github.com/articles/about-labels) to add to each issue and pull request resolved by the release. Set to `false` to not add any label. See [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 [addReleases](#addReleases).
+   * @default `false`
+   */
+  addReleases?: boolean;
 }
 
 export interface NPMPluginOpts {