@wjwjq/release-helper 0.1.5 → 0.1.7

package/src/pack.ts

@@ -1,152 +0,0 @@
-import fs from "fs"
-import path from "path"
-
-import * as inquirer from "@inquirer/prompts"
-import pc from "picocolors"
-import * as tar from 'tar'
-
-import { __work_dir, __releaseDir, __dirname, releaseConf, checkEnvInfo } from './prepare'
-import { logger } from "./logger"
-
-export async function pack(version?: string) {
-  try {
-    await checkEnvInfo();
-    
-    if (version === undefined) {
-       version = await inquirer.input(
-        {
-          message: '请输入版本号：',
-        },
-      )
-    }
-
-    if (version == '') {
-      logger.error('版本号不能为空！')
-      return
-    }
-
-    const packageJson = JSON.parse(fs.readFileSync(path.resolve(__work_dir, 'package.json'), { 'encoding': 'utf-8' }))
-    const projectName = packageJson.name as string;
-
-    if (!projectName) {
-      logger.error('未在package.json找到name定义！')
-      return
-    }
-
-    const zipFileName = `${projectName}_${version}.tar.gz`
-
-    logger.tip(`start to pack`)
-    
-    const projectDir = path.resolve(__releaseDir, projectName); //eg .release/posidon-frontend
-    const assetsDir = path.resolve(projectDir, 'pkg/assets');
-    const nginxDir = path.resolve(projectDir, 'pkg/nginx')
-    
-    // 复制整个安装脚本和nginx二进制包
-    fs.cpSync(path.resolve(__dirname, 'deploy'), projectDir, { recursive: true })
-    // 复制打包后的静态资源
-    fs.cpSync(path.resolve(__work_dir, releaseConf.assetsDir), assetsDir, { recursive: true })
-
-    // 添加版本信息
-    fs.writeFileSync(path.resolve(projectDir, 'pkg', 'version'), version, { encoding: 'utf-8' })
-    fs.writeFileSync(path.resolve(assetsDir, 'version'), version, { encoding: 'utf-8' })
-    fs.writeFileSync(path.resolve(nginxDir, 'version'), version, { encoding: 'utf-8' })
-
-    logger.info(pc.green(`version: ${version} added`))
-
-    const assetInstallPath = `/opt/${projectName}/`
-    logger.info(pc.green(`start to replace variants in common.sh`))
-
-    // 替换安装脚本 与nginx匹配的名称
-    replaceFileContent({
-      filePath: path.resolve(projectDir, 'script', 'common.sh'),
-      replaced: [
-        ['__APP_NAME__', `"${projectName}"`],
-        ['__INSTALL_PATH__', assetInstallPath],
-        ['__USER__', releaseConf.user],
-        ['__USER_GROUP__', releaseConf.userGroup],
-      ]
-    })
-
-    // 替换安装模式
-    replaceFileContent({
-      filePath: path.resolve(projectDir, 'script', 'prompt.sh'),
-      replaced: [
-        ['__INSTALL_MODE__', releaseConf.installMode],
-      ]
-    })
-
-    logger.info(pc.green(`start to replace version: ${version} in index.html`))
-
-    replaceFileContent({
-      filePath: path.resolve(assetsDir, 'index.html'),
-      replaced: [['__version__', version]]
-    })
-
-    // 生成nginx.conf文件
-    logger.info(pc.green(`start to generate nginx.conf`))
-
-    //复制用户指定的nginx配置信息
-    fs.cpSync(path.resolve(__releaseDir, 'nginx'), nginxDir, { recursive: true, force: true })
-
-    replaceFileContent({
-      filePath: path.resolve(nginxDir, 'nginx.conf'),
-      replaced: [['__root__', `${assetInstallPath}assets/`]],
-      // writeToNewFilePath: path.resolve(nginxDir, `${projectName}.conf`)
-    })
-
-    logger.info(pc.green(`start to generate ${zipFileName}`))
-
-    const zipFilePath = path.resolve(__releaseDir, zipFileName)
-    await genTarPkg(__releaseDir, projectName, zipFilePath);
-
-    logger.success(`done to pack ${pc.green(`${zipFileName} at: ${__releaseDir}`)}`);
-
-    if (fs.existsSync(projectDir)) {
-      fs.rmSync(projectDir, { recursive: true, force: true })
-    }
-
-    return {
-      version,
-      pkgName: zipFileName,
-      appName: projectName,
-      pkgFilePath: zipFilePath
-    }
-  } catch (error) {
-    console.error('Error:', error);
-    return Promise.reject(error);
-  }
-}
-
-function genTarPkg(releaseDir: string, projectName: string, zipFileName: string) {
-  return new Promise((resolve, reject) => {
-    const zipStream = fs.createWriteStream(zipFileName);
-    zipStream.on('close', () => {
-      resolve(true);
-    })
-
-    try {
-      tar.create(
-        {
-          z: true,
-          cwd: releaseDir,
-        },
-        [projectName],
-      ).pipe(zipStream)
-    } catch (error) {
-      reject(error);
-    }
-  })
-}
-
-function replaceFileContent(params: {filePath: string; writeToNewFilePath?: string; replaced: [string, string][] }) {
-  const { filePath, writeToNewFilePath, replaced = [] } = params
-  if (fs.existsSync(filePath)) {
-    let content = fs.readFileSync(filePath, { encoding: 'utf-8' })
-
-    replaced.forEach(([regExp, replaceContent]) => {
-      content = content.toString().replace(regExp, replaceContent);
-    });
-
-    fs.writeFileSync(writeToNewFilePath ? writeToNewFilePath : filePath, content, { encoding: 'utf-8' })
-  }
-}

package/src/prepare.ts

@@ -1,120 +0,0 @@
-import path, { dirname } from "path";
-import fs from "fs"
-import YAML from 'yaml';
-import * as inquirer from "@inquirer/prompts"
-
-import { execa } from 'execa';
-import { fileURLToPath } from "node:url";
-
-import { logger } from './logger';
-
-const installMode = ['standalone',  'cluster', 'both'] as const;
-
-export type ReleaseConf = {
-  /** gitlab 仓库地址 */
-  host: string
-  /** gitlab rest api token */
-  token: string
-  /** 打包脚本 默认npm run build */
-  buildCmd?: string
-  /** 打包后资源 相对工作区所在路径  默认dist/*/
-  assetsDir?: string
-  /** nginx和assets 所属用户和用户组  默认: root*/
-  user: string
-  userGroup: string
-  /* 指定安装模式  standalone(supervisor) 、 cluster（agent\systemd) 、 both */
-  installMode: (typeof installMode)[number]
-}
-
-// 获取项目根目录
-export const __work_dir = process.env.INIT_CWD || process.cwd();
-export const __releaseDir = path.resolve(__work_dir, '.release')
-
-const __filename = fileURLToPath(import.meta.url);
-export const __dirname = dirname(__filename);
-
-export const releaseConfFileName = "release.conf.yaml"
-export const __releaseConfPath = path.resolve(__releaseDir, releaseConfFileName);
-
-function parseConf(file: string) {
-  try {
-    const conf = fs.readFileSync(file, "utf-8");
-    return YAML.parse(conf) as ReleaseConf
-  } catch (error) {
-    return {} as ReleaseConf;
-  }
-}
-
-export const releaseConf: Required<ReleaseConf> = Object.assign({
-  host: '',
-  token: '',
-  /** 打包脚本 默认npm run build */
-  buildCmd: 'npm run build',
-  /** 打包后资源 相对工作区所在路径  默认dist/*/
-  assetsDir: 'dist',
-  user: 'root',
-  userGroup: 'root',
-  installMode: 'both'
-}, parseConf(__releaseConfPath));
-
-export const $ = execa({ encoding: 'utf8' });
-
-export async function prepare() {
-  const copyFiles = () => {
-      // 将.release file copy 到__work_dir 目录下 
-      fs.cpSync(path.resolve(__dirname, '.release'), __releaseDir, { recursive: true })
-  }
-
-  if (!fs.existsSync(__releaseDir)) {
-      
-    fs.mkdirSync(__releaseDir)
-    copyFiles();
-    logger.tip(`请注意修改.release/${releaseConfFileName} 配置信息`) 
-  }else {
-    if(!process.env.INIT_CWD){ // Npm环境下 无法交互 会阻塞install
-      const shouldRegenerate = await inquirer.confirm(
-        {
-          message: '.release配置已存在，是否重新生成？',
-        },
-      ) 
-
-      if(shouldRegenerate){
-        copyFiles()
-      }
-    }
-  } 
-}
-
-export async function checkEnvInfo() {
-  // 检查是否在 git 仓库中
-  const { stdout: isGitRepo } = await $(`git rev-parse --is-inside-work-tree`)
-  if (isGitRepo !== 'true') {
-    logger.error('当前项目不是git仓库')
-    process.exit(1);
-  }
-
-  // 检查.release下 nginx.conf, release.conf.yaml 等文件是否存在
-
-  if (!fs.existsSync(path.resolve(__releaseDir, 'nginx/nginx.conf'))) {
-    logger.error('.release目录下不存在nginx/nginx.conf 文件， 请使用 release-helper init 初始化生成')
-    process.exit(1);
-  }
-
-  if (!fs.existsSync(__releaseConfPath)) {
-    logger.error(`.release目录下不存在${releaseConfFileName}文件，请使用 release-helper init 初始化生成`)
-    process.exit(1);
-  }
-
-  for(let [field, value] of Object.entries(releaseConf)){
-    if (!value) {
-      logger.error(`The field: [${field}] is required in  .release/release.conf.yaml!`);
-      process.exit(1);
-    }
-
-    if(field === 'installMode' && !installMode.includes(value as (typeof installMode)[number])){
-      logger.error(`The field: [${field}]'s value should be one of ${installMode.join(' | ')}`);
-      process.exit(1);
-    }
-  }
-}
- 

package/src/publish.ts

@@ -1,308 +0,0 @@
-import fs from "fs"
-import path from "path"
-import { URL } from "url"
-import crypto from "crypto"
-import mime from 'mime'
-import * as inquirer from "@inquirer/prompts"
-import { setTimeout } from 'node:timers/promises';
-
-import { Gitlab } from "@gitbeaker/rest"
-
-import { __releaseDir, releaseConf, $ } from './prepare'
-import { logger } from "./logger"
-
-export async function isGitFlowRepo() {
-  try {
-    let { stdout } = await $('git config', ['--get-regexp', `^gitflow\.`])
-    return stdout.toString().length > 0;
-  } catch (error) {
-    console.error("🚀 ~ doGitFlowRelease ~ error:", error)
-  }
-
-  return false;
-}
-
-async function getRepo() {
-  const res = await $`git remote -v `.pipe` sed -n '1p'`.pipe`awk -F ' ' '{print $2}'`.pipe`sed -e 's/.git//'`;
-  const repo = res.stdout.replace("\n", "");
-
-  if (repo.startsWith("git@")) {
-    const ps = repo.split("/");
-    return {
-      isHttpRepo: false,
-      repo: repo.split(":")[1],
-      repoName: ps[ps.length - 1].replace(".git", "")
-    };
-  }
-
-  const url = new URL(repo);
-  const ps = url.pathname.split("/");
-
-  return {
-    isHttpRepo: true,
-    repo: url.pathname,
-    origin: url.origin,
-    repoName: ps[ps.length - 1]
-  };
-}
-
-async function getChangeLog(host: string, newVersion: string, userSelectedLatestTag: string, markdownUrls: { tar: string, md5: string, doc: string }) {
-  async function getLog() {
-    let output = "";
-    try {
-      /** 
-       * 判断是否为gitflow 
-       *  
-       *  --> 是 获取最近两次tag 之间的commit记录，  若不足两次，则获取最新一次往前的所有记录
-       *  --> 否 获取最近一次tag 之后的commit记录
-       */
-
-      const isGitFlow = await isGitFlowRepo();
-
-      const { stdout } = await $`git tag --sort=-creatordate`;
-      const tags = stdout.split('\n');
-      const latestTag = tags[0]
-      let tagRange = '';
-      if (isGitFlow) {
-        if (tags.length >= 2) {
-          const secondLastTag = userSelectedLatestTag !== '' ? userSelectedLatestTag : tags[1]
-          tagRange = `${secondLastTag}..${latestTag}`
-        } else if (tags.length === 1) {
-          tagRange = latestTag;
-        }
-      } else {
-        if (tags.length >= 1) {
-          tagRange = `${latestTag}..HEAD`;
-        } 
-      }
-      
-      let logCmd = `git log ${tagRange} --format=%B%H----DELIMITER---- --abbrev-commit`;
-      const { stdout: r } = await $(logCmd);
-      output = r;
-    } catch (error) {
-      console.error("🚀 ~ getLog ~ error:", error)
-      const { stdout: r } = await $`git log --format=%B%H----DELIMITER----`;
-      output = r;
-    }
-
-    return output;
-  }
-
-  const output = await getLog();
-
-  const commitsArray = output
-    .split("----DELIMITER----\n")
-    .map(commit => {
-      const [message, sha] = commit.split("\n").filter(msg => msg != "" && !msg.startsWith("Merge"));
-      return { sha, message };
-    })
-    .filter(commit => Boolean(commit.sha));
-
-  let currentChangelog = "";
-
-  // if (fs.existsSync(path.resolve(__dirname, "../CHANGELOG.md"))) {
-  //   currentChangelog = fs.readFileSync(path.resolve(__dirname, "../CHANGELOG.md"), "utf-8");
-  // }
-
-  const { repo } = await getRepo();
-
-  // 用version和时间作为release 标记
-  let newChangelog = ``;// `# ${newVersion} (${new Date().toISOString().split("T")[0]})\n\n`;
-
-  let features: string[] = [];
-  let Bugfixes: string[] = [];
-
-  // 分别维护features和bugfixes的内容，并将message和commit的链接进行绑定
-  commitsArray.forEach(commit => {
-    const commitSha = `([${commit.sha.substring(0, 6)}](${host}/${repo}/-/commit/${commit.sha}))`;
-
-    if (commit.message.startsWith("feat:") || commit.message.startsWith("feat：")) {
-      const feats = commit.message.replace(/feat[:|：]/, "").replace(/;|；/g, "$").split("$");
-      features = features.concat(feats.map(f => `* ${f.replace(/^\s+/, "")} ${commitSha}\n`,));
-
-    }
-    if (commit.message.startsWith("fix:") || commit.message.startsWith("fix：")) {
-      const fixes = commit.message.replace(/fix[:|：]/, "").replace(/;|；/g, "$").split("$");
-      Bugfixes = Bugfixes.concat(fixes.map(f => `* ${f.replace(/^\s+/, "")} ${commitSha}\n`,));
-    }
-  });
-
-  if (features.length) {
-    newChangelog += `# Features\n`;
-    features.forEach(feature => {
-      newChangelog += feature;
-    });
-    newChangelog += "\n";
-  }
-
-  if (Bugfixes.length) {
-    newChangelog += `# Bugfixes\n`;
-    Bugfixes.forEach(bugfix => {
-      newChangelog += bugfix;
-    });
-    newChangelog += "\n";
-  }
-  console.log("🚀 ~ getChangeLog ~features & Bugfixes:", features, Bugfixes)
-
-  // add attach
-  newChangelog += `# Artifacts\n`;
-  newChangelog += `## tar包\n`;
-  newChangelog += `${markdownUrls.tar}\n`;
-
-  newChangelog += `## md5\n`;
-  newChangelog += `${markdownUrls.md5}\n`;
-
-  newChangelog += `## 文档\n`;
-  newChangelog += `${markdownUrls.doc}\n`;
-
-
-  // prepend the newChangelog to the current one
-  return `${newChangelog}${currentChangelog}`;
-}
-
-export async function getGitTags(){
-  const { stdout } = await $`git tag --sort=-creatordate`;
-  return stdout.split('\n');
-}
-
-export async function selectLatestTag(targetVersion: string){
-  let latestTag = '';
-  const tags = await getGitTags();
-
-  if(tags.length >= 2){
-    const ac = new AbortController(); 
-   const prompt = inquirer
-    .select(
-      {
-        message: '请选择发布信息从哪次tag开始生成，（默认： 最近一次，特别针对某主版本之间有小版本过渡的情况）(timing out in 10 seconds)：',
-        default: tags[0],
-        choices: tags.filter(item => item !== targetVersion).map(tag => ({ value: tag})),
-      },
-    )
-    prompt
-      .finally(() => {
-        ac.abort();
-      })
-      // Silencing the cancellation error.
-      .catch(() => {});
-
-    const defaultValue = setTimeout(10000, 'timeout', { signal: ac.signal }).then(() => {
-      prompt.cancel();
-      return tags[0];
-    });
-
-    latestTag = await Promise.race([defaultValue, prompt]);
-  }
-
-  return latestTag
-}
-
-export async function publish(params: {
-  version: string;
-  pkgName: string;
-  appName: string;
-  remoteBranch: string;
-  userSelectedLatestTag: string
-}) {
-  const {
-    version,
-    pkgName,
-    appName,
-    remoteBranch,
-    userSelectedLatestTag = ''
-  } = params || {};
- 
-  try {
-    const { repo } = await getRepo();
-
-    const { host, token } = releaseConf; 
-
-    logger.tip('start to publish');
-    
-    const api = new Gitlab({
-      host,
-      token,
-      rejectUnauthorized: false
-    });
-
-    const projects = await api.Projects.all();
-
-    const proj = projects.find(item => item.path_with_namespace === repo);
-
-    if (proj === undefined) {
-      throw Error(`The target repo not founded!`);
-    }
-
-    const id = proj.id;
-
-    const assetFile = path.resolve(__releaseDir, pkgName);
-    const file = fs.readFileSync(assetFile);
-
-    const hash = crypto.createHash("md5");
-    hash.update(file);
-    const md5 = hash.digest("hex");
-    const md5FileName = `${appName}_${version}.md5.txt`;
-
-    // 读取doc目录下所有文档并上传
-    const docPath = path.join(__releaseDir, "doc")
-    // 替换文件档中的变量
-    const replacedConstants = [["\\$APP_NAME\\$", appName], ["\\$VERSION\\$", version], ["\\$TAR_PKG\\$", pkgName]];
-
-    const docUploadsPromises = fs.readdirSync(docPath)
-      .map(docFIleName => {
-        const docFilePath = path.resolve(docPath, docFIleName)
-        const stats = fs.statSync(docFilePath)
-        if (stats.isFile()) {
-          let content = fs.readFileSync(docFilePath).toString();
-
-          const doc = replacedConstants.reduce((prev, [reg, value]) => {
-            return prev.replace(new RegExp(reg, 'g'), value);
-          }, content)
- 
-          return api.Projects.uploadForReference(id, { content: new Blob([doc], { type: mime.getType(docFIleName)! }), filename: docFIleName })
-        }
-      }).filter(item => item)
-
-    logger.info('start to upload resources')
-    const [tarUploads, md5Uploads, ...docUploads] = await Promise.all([
-      api.Projects.uploadForReference(id, { content: new Blob([file], { type: 'application/gzip' }), filename: pkgName }),
-      api.Projects.uploadForReference(id, { content: new Blob([md5], { type: 'text/plain' }), filename: md5FileName }),
-      ...docUploadsPromises,
-    ]);
-    
-    const description = await getChangeLog(host, version, userSelectedLatestTag, { tar: tarUploads.markdown, md5: md5Uploads.markdown, doc: docUploads.map(item => item!.markdown).join('\n') });
-
-    logger.tip("start tag and release to git repo") 
-
-    const tags = await api.Tags.all(id);
-    if (tags.find(r => r.name === version) === undefined) {
-      await api.Tags.create(id, version, remoteBranch);
-    }
-
-    const releases = await api.ProjectReleases.all(id);
-    let res;
-    if (releases.find(r => r.name === version)) {
-      res = await api.ProjectReleases.edit(id, version, {
-        description
-      });
-    } else {
-      res = await api.ProjectReleases.create(id, {
-        tag_name: version,
-        description
-      });
-    }
-
-    // 通过assets api 发布 artifacts
-    await api.ReleaseLinks.create(id, version, pkgName, `${host}${tarUploads.full_path}`, { linkType: "package" });
-    await api.ReleaseLinks.create(id, version, md5FileName, `${host}${md5Uploads.full_path}`, { linkType: "other" });
-    await Promise.all(docUploads.map(doc => api.ReleaseLinks.create(id, version, doc!.alt, `${host}${doc!.full_path}`, { linkType: "other" })));
-
-    fs.unlinkSync(assetFile);
-
-    logger.success(`Successfully released at: ${res._links.self} `)
-  } catch (error) {
-    logger.error("🚀 ~ file: publish.js ~ error:")
-    console.error(error);
-    return Promise.reject(error)
-  }
-}