feat: support command on published/only-changesets (#7)

Author: JounQin

.changeset/nice-ads-cheer.md

@@ -0,0 +1,5 @@
+---
+"changesets-gitlab": minor
+---
+
+feat: support command on published/only-changesets

README.md

@@ -28,6 +28,11 @@ GitLab CI cli for [changesets](https://github.com/atlassian/changesets) like its
 - commit - The commit message to use. Default to `Version Packages`
 - title - The merge request title. Default to `Version Packages`
 
+#### Only available in `changesets-gitlab`
+
+- published - Command executed after published
+- only_changesets - Command executed on only changesets detected
+
 ### Outputs
 
 - published - A boolean value to indicate whether a publishing is happened or not
@@ -66,7 +71,7 @@ comment:
  image: node:lts-alpine
  stage: comment
  only: merge_requests
- script: yarn changesets-gitlab -c # comment automatically like https://github.com/changesets/bot
+ script: yarn changesets-gitlab comment # comment automatically like https://github.com/changesets/bot
 
 release:
  image: node:lts-alpine
@@ -89,7 +94,7 @@ comment:
  image: node:lts-alpine
  stage: comment
  only: merge_requests
- script: yarn changesets-gitlab -c
+ script: yarn changesets-gitlab comment
 
 release:
  image: node:lts-alpine
@@ -134,7 +139,7 @@ comment:
  stage: comment
  only:
  - merge_requests
- script: yarn changesets-gitlab -c
+ script: yarn changesets-gitlab comment
 
 release:
  image: node:lts-alpine
@@ -160,7 +165,7 @@ comment:
  stage: comment
  only:
  - merge_requests
- script: yarn changesets-gitlab -c
+ script: yarn changesets-gitlab comment
 
 release:
  image: node:lts-alpine

package.json

@@ -42,6 +42,7 @@
  "@gitbeaker/node": "^32.1.2",
  "@manypkg/get-packages": "^1.1.1",
  "@sentry/node": "^6.11.0",
+ "commander": "^8.1.0",
  "dotenv": "^10.0.0",
  "fs-extra": "^10.0.0",
  "global-agent": "^3.0.0",

src/cli.ts

@@ -2,12 +2,19 @@
 
 import './env.js'
 
+import _ from 'module'
+
 import { setFailed } from '@actions/core'
+import { program } from 'commander'
 
 import { comment } from './comment.js'
 import { main } from './main.js'
+import { getOptionalInput } from './utils.js'
+
+const cjsRequire =
+ typeof require === 'undefined' ? _.createRequire(import.meta.url) : require
 
-const cli = async () => {
+const run = async () => {
  const { GITLAB_CI_USER_NAME, GITLAB_TOKEN } = process.env
 
  if (!GITLAB_TOKEN || !GITLAB_CI_USER_NAME) {
@@ -17,10 +24,29 @@ const cli = async () => {
  return
  }
 
- return ['-c', '--comment'].includes(process.argv[2]) ? comment() : main()
+ program.version(
+ (cjsRequire('../package.json') as { version: string }).version,
+ )
+
+ program.command('comment').action(async () => {
+ await comment()
+ })
+
+ program
+ .command('main', {
+ isDefault: true,
+ })
+ .action(() =>
+ main({
+ published: getOptionalInput('published'),
+ onlyChangesets: getOptionalInput('only_changesets'),
+ }),
+ )
+
+ return program.showHelpAfterError().parseAsync()
 }
 
-cli().catch((err: Error) => {
+run().catch((err: Error) => {
  console.error(err)
  process.exit(1)
 })

src/comment.ts

@@ -34,7 +34,7 @@ const getReleasePlanMessage = (releasePlan: ReleasePlan | null) => {
  ]),
  ])
 
- return `<details><summary>This PR includes ${
+ return `<details><summary>This MR includes ${
  releasePlan.changesets.length > 0
  ? `changesets to release ${
  publishableReleases.length === 1
@@ -47,7 +47,7 @@ const getReleasePlanMessage = (releasePlan: ReleasePlan | null) => {
  ${
  publishableReleases.length > 0
  ? table
- : "When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types"
+ : "When changesets are added to this MR, you'll see the packages that this MR includes changesets for and the associated semver types"
  }
 
 </details>`
@@ -61,13 +61,13 @@ const getAbsentMessage = (
 
 Latest commit: ${commitSha}
 
-Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. **If these changes should result in a version bump, you need to add a changeset.**
+Merging this MR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. **If these changes should result in a version bump, you need to add a changeset.**
 
 ${getReleasePlanMessage(releasePlan)}
 
 [Click here to learn what changesets are, and how to add one](https://github.com/changesets/changesets/blob/master/docs/adding-a-changeset.md).
 
-[Click here if you're a maintainer who wants to add a changeset to this PR](${addChangesetUrl})
+[Click here if you're a maintainer who wants to add a changeset to this MR](${addChangesetUrl})
 
 `
 
@@ -79,13 +79,13 @@ const getApproveMessage = (
 
 Latest commit: ${commitSha}
 
-**The changes in this PR will be included in the next version bump.**
+**The changes in this MR will be included in the next version bump.**
 
 ${getReleasePlanMessage(releasePlan)}
 
 Not sure what this means? [Click here to learn what changesets are](https://github.com/changesets/changesets/blob/master/docs/adding-a-changeset.md).
 
-[Click here if you're a maintainer who wants to add another changeset to this PR](${addChangesetUrl})
+[Click here if you're a maintainer who wants to add another changeset to this MR](${addChangesetUrl})
 
 `
 
@@ -159,7 +159,7 @@ export const comment = async () => {
  api,
  }).catch((err: unknown) => {
  if (err instanceof ValidationError) {
- errFromFetchingChangedFiles = `<details><summary>💥 An error occurred when fetching the changed packages and changesets in this PR</summary>\n\n\`\`\`\n${err.message}\n\`\`\`\n\n</details>\n`
+ errFromFetchingChangedFiles = `<details><summary>💥 An error occurred when fetching the changed packages and changesets in this MR</summary>\n\n\`\`\`\n${err.message}\n\`\`\`\n\n</details>\n`
  } else {
  console.error(err)
  captureException(err)

src/main.ts

@@ -7,8 +7,13 @@ import { exec } from '@actions/exec'
 import { setupUser } from './gitUtils.js'
 import readChangesetState from './readChangesetState.js'
 import { runPublish, runVersion } from './run.js'
+import { MainCommandOptions } from './types.js'
+import { execSync, getOptionalInput } from './utils.js'
 
-export const main = async () => {
+export const main = async ({
+ published,
+ onlyChangesets,
+}: MainCommandOptions = {}) => {
  const {
  CI,
  CI_PROJECT_PATH,
@@ -47,9 +52,10 @@ export const main = async () => {
  const hasPublishScript = !!publishScript
 
  switch (true) {
- case !hasChangesets && !hasPublishScript:
+ case !hasChangesets && !hasPublishScript: {
  console.log('No changesets found')
  return
+ }
  case !hasChangesets && hasPublishScript: {
  console.log(
  'No changesets found, attempting to publish any unpublished packages to npm',
@@ -79,16 +85,23 @@ export const main = async () => {
  if (result.published) {
  setOutput('published', true)
  setOutput('publishedPackages', result.publishedPackages)
+ if (published) {
+ execSync(published)
+ }
  }
  return
  }
- case hasChangesets:
+ case hasChangesets: {
  await runVersion({
- script: getInput('version'),
+ script: getOptionalInput('version'),
  gitlabToken: GITLAB_TOKEN!,
- prTitle: getInput('title'),
- commitMessage: getInput('commit'),
+ mrTitle: getOptionalInput('title'),
+ commitMessage: getOptionalInput('commit'),
  hasPublishScript,
  })
+ if (onlyChangesets) {
+ execSync(onlyChangesets)
+ }
+ }
  }
 }

src/run.ts

@@ -182,7 +182,7 @@ interface VersionOptions {
  script?: string
  gitlabToken: string
  cwd?: string
- prTitle?: string
+ mrTitle?: string
  commitMessage?: string
  hasPublishScript?: boolean
 }
@@ -191,7 +191,7 @@ export async function runVersion({
  script,
  gitlabToken,
  cwd = process.cwd(),
- prTitle = 'Version Packages',
+ mrTitle = 'Version Packages',
  commitMessage = 'Version Packages',
  hasPublishScript = false,
 }: VersionOptions) {
@@ -201,6 +201,7 @@ export async function runVersion({
  const { preState } = await readChangesetState(cwd)
 
  await gitUtils.switchToMaybeExistingBranch(versionBranch)
+ await exec('git', ['fetch', 'origin', branch])
  await gitUtils.reset(`origin/${branch}`)
 
  const versionsByDirectory = await getVersionsByDirectory(cwd)
@@ -220,12 +221,12 @@ export async function runVersion({
 
  const changedPackages = await getChangedPackages(cwd, versionsByDirectory)
 
- const prBodyPromise = (async () =>
- `This PR was opened by the [changesets-gitlab](https://github.com/rx-ts/changesets-gitlab) GitLab CI script. When you're ready to do a release, you can merge this and ${
+ const mrBodyPromise = (async () =>
+ `This MR was opened by the [changesets-gitlab](https://github.com/rx-ts/changesets-gitlab) GitLab CI script. When you're ready to do a release, you can merge this and ${
  hasPublishScript
  ? 'the packages will be published to npm automatically'
  : 'publish to npm yourself or [setup this action to publish automatically](https://github.com/rx-ts/changesets-gitlab#with-publishing)'
- }. If you're not ready to do a release yet, that's fine, whenever you add more changesets to ${branch}, this PR will be updated.
+ }. If you're not ready to do a release yet, that's fine, whenever you add more changesets to ${branch}, this MR will be updated.
 ${
  preState
  ? `
@@ -267,7 +268,7 @@ ${
  .map(x => x.content)
  .join('\n '))()
 
- const finalPrTitle = `${prTitle}${preState ? ` (${preState.tag})` : ''}`
+ const finalMrTitle = `${mrTitle}${preState ? ` (${preState.tag})` : ''}`
 
  // project with `commit: true` setting could have already committed files
  if (!(await gitUtils.checkIfClean())) {
@@ -289,21 +290,21 @@ ${
  })
  console.log(JSON.stringify(searchResult, null, 2))
  if (searchResult.length === 0) {
- console.log('creating pull request')
+ console.log('creating merge request')
  await api.MergeRequests.create(
  context.projectId,
  versionBranch,
  branch,
- finalPrTitle,
+ finalMrTitle,
  {
- description: await prBodyPromise,
+ description: await mrBodyPromise,
  },
  )
  } else {
  await api.MergeRequests.edit(context.projectId, searchResult[0].iid, {
- title: finalPrTitle,
- description: await prBodyPromise,
+ title: finalMrTitle,
+ description: await mrBodyPromise,
  })
- console.log('pull request found')
+ console.log('merge request found')
  }
 }

src/types.ts

@@ -0,0 +1,4 @@
+export interface MainCommandOptions {
+ published?: string
+ onlyChangesets?: string
+}

src/utils.ts

@@ -1,12 +1,14 @@
+import { execSync as _execSync } from 'child_process'
 import fs from 'fs'
 import path from 'path'
 
-import { unified } from 'unified'
-import remarkParse from 'remark-parse'
-import remarkStringify from 'remark-stringify'
-import { toString as mdastToString } from 'mdast-util-to-string'
+import { getInput } from '@actions/core'
 import { exec } from '@actions/exec'
 import { getPackages, Package } from '@manypkg/get-packages'
+import { toString as mdastToString } from 'mdast-util-to-string'
+import remarkParse from 'remark-parse'
+import remarkStringify from 'remark-stringify'
+import { unified } from 'unified'
 
 export const BumpLevels = {
  dep: 0,
@@ -142,3 +144,10 @@ export async function getAllFiles(dir: string, base = dir): Promise<string[]> {
  )
  return files.flat()
 }
+
+export const execSync = (command: string) =>
+ _execSync(command, {
+ stdio: 'inherit',
+ })
+
+export const getOptionalInput = (name: string) => getInput(name) || undefined

test/__snapshots__/utils.spec.ts.snap

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`utils 1`] = `
+exports[`utils getAllFiles 1`] = `
 Array [
  ".gitkeep",
  "dir/.gitkeep",