Create new plugin : one-release-commit #2180

jBouyoud · 2022-03-22T17:01:14Z

Create a new plugin to handle this discussion

What Changed

refactor(core): split release creation in two steps

Refactoring needed for the next commit to allow forward current releasing version in afterVersion hook.
feat(core): add version in afterVersion hook

Add version in afterVersion hook
feat(one-release-commit): create plugin with automation

Create plugin boiler plate with automation
feat(one-release-commit): first implementation

First implementation of this plugin

Why

Some users might want a single atomic commit that represent the release (also easy to rollback).

Add tests (Also tested in a real repo)
Add docs

Change Type

Indicate the type of change your pull request is:

documentation
patch
minor
major

🐤 Download canary assets:

auto-linux--canary.2180.26196.gz
auto-macos--canary.2180.26196.gz
auto-win.exe--canary.2180.26196.gz

📦 Published PR as canary version: under canary scope @auto-canary@10.37.0--canary.2180.26196.0

✨ Test out this PR locally via:

npm install @auto-canary/bot-list@10.37.0--canary.2180.26196.0
npm install @auto-canary/auto@10.37.0--canary.2180.26196.0
npm install @auto-canary/core@10.37.0--canary.2180.26196.0
npm install @auto-canary/package-json-utils@10.37.0--canary.2180.26196.0
npm install @auto-canary/all-contributors@10.37.0--canary.2180.26196.0
npm install @auto-canary/brew@10.37.0--canary.2180.26196.0
npm install @auto-canary/chrome@10.37.0--canary.2180.26196.0
npm install @auto-canary/cocoapods@10.37.0--canary.2180.26196.0
npm install @auto-canary/conventional-commits@10.37.0--canary.2180.26196.0
npm install @auto-canary/crates@10.37.0--canary.2180.26196.0
npm install @auto-canary/docker@10.37.0--canary.2180.26196.0
npm install @auto-canary/exec@10.37.0--canary.2180.26196.0
npm install @auto-canary/first-time-contributor@10.37.0--canary.2180.26196.0
npm install @auto-canary/gem@10.37.0--canary.2180.26196.0
npm install @auto-canary/gh-pages@10.37.0--canary.2180.26196.0
npm install @auto-canary/git-tag@10.37.0--canary.2180.26196.0
npm install @auto-canary/gradle@10.37.0--canary.2180.26196.0
npm install @auto-canary/jira@10.37.0--canary.2180.26196.0
npm install @auto-canary/magic-zero@10.37.0--canary.2180.26196.0
npm install @auto-canary/maven@10.37.0--canary.2180.26196.0
npm install @auto-canary/microsoft-teams@10.37.0--canary.2180.26196.0
npm install @auto-canary/npm@10.37.0--canary.2180.26196.0
npm install @auto-canary/omit-commits@10.37.0--canary.2180.26196.0
npm install @auto-canary/omit-release-notes@10.37.0--canary.2180.26196.0
npm install @auto-canary/one-release-commit@10.37.0--canary.2180.26196.0
npm install @auto-canary/pr-body-labels@10.37.0--canary.2180.26196.0
npm install @auto-canary/released@10.37.0--canary.2180.26196.0
npm install @auto-canary/s3@10.37.0--canary.2180.26196.0
npm install @auto-canary/sbt@10.37.0--canary.2180.26196.0
npm install @auto-canary/slack@10.37.0--canary.2180.26196.0
npm install @auto-canary/twitter@10.37.0--canary.2180.26196.0
npm install @auto-canary/upload-assets@10.37.0--canary.2180.26196.0
npm install @auto-canary/vscode@10.37.0--canary.2180.26196.0
# or 
yarn add @auto-canary/bot-list@10.37.0--canary.2180.26196.0
yarn add @auto-canary/auto@10.37.0--canary.2180.26196.0
yarn add @auto-canary/core@10.37.0--canary.2180.26196.0
yarn add @auto-canary/package-json-utils@10.37.0--canary.2180.26196.0
yarn add @auto-canary/all-contributors@10.37.0--canary.2180.26196.0
yarn add @auto-canary/brew@10.37.0--canary.2180.26196.0
yarn add @auto-canary/chrome@10.37.0--canary.2180.26196.0
yarn add @auto-canary/cocoapods@10.37.0--canary.2180.26196.0
yarn add @auto-canary/conventional-commits@10.37.0--canary.2180.26196.0
yarn add @auto-canary/crates@10.37.0--canary.2180.26196.0
yarn add @auto-canary/docker@10.37.0--canary.2180.26196.0
yarn add @auto-canary/exec@10.37.0--canary.2180.26196.0
yarn add @auto-canary/first-time-contributor@10.37.0--canary.2180.26196.0
yarn add @auto-canary/gem@10.37.0--canary.2180.26196.0
yarn add @auto-canary/gh-pages@10.37.0--canary.2180.26196.0
yarn add @auto-canary/git-tag@10.37.0--canary.2180.26196.0
yarn add @auto-canary/gradle@10.37.0--canary.2180.26196.0
yarn add @auto-canary/jira@10.37.0--canary.2180.26196.0
yarn add @auto-canary/magic-zero@10.37.0--canary.2180.26196.0
yarn add @auto-canary/maven@10.37.0--canary.2180.26196.0
yarn add @auto-canary/microsoft-teams@10.37.0--canary.2180.26196.0
yarn add @auto-canary/npm@10.37.0--canary.2180.26196.0
yarn add @auto-canary/omit-commits@10.37.0--canary.2180.26196.0
yarn add @auto-canary/omit-release-notes@10.37.0--canary.2180.26196.0
yarn add @auto-canary/one-release-commit@10.37.0--canary.2180.26196.0
yarn add @auto-canary/pr-body-labels@10.37.0--canary.2180.26196.0
yarn add @auto-canary/released@10.37.0--canary.2180.26196.0
yarn add @auto-canary/s3@10.37.0--canary.2180.26196.0
yarn add @auto-canary/sbt@10.37.0--canary.2180.26196.0
yarn add @auto-canary/slack@10.37.0--canary.2180.26196.0
yarn add @auto-canary/twitter@10.37.0--canary.2180.26196.0
yarn add @auto-canary/upload-assets@10.37.0--canary.2180.26196.0
yarn add @auto-canary/vscode@10.37.0--canary.2180.26196.0

jBouyoud · 2022-05-31T09:43:54Z

@hipstersmoothie here an implementation proposal to handle #1949

jBouyoud · 2022-08-11T07:14:12Z

@hipstersmoothie anything that I can do to help merge this PR ?

jBouyoud · 2023-02-08T11:10:28Z

@hipstersmoothie I also rebase this PR ;-P

jBouyoud · 2023-02-09T09:55:21Z

Same as #2182 (comment)

jBouyoud · 2023-02-10T16:45:55Z

@hipstersmoothie Let me know if everything miss to merge this 🎉

First step create a release context (from release, to, newVersion) Second step use this information to really make the release

jBouyoud · 2023-02-24T14:19:03Z

@hipstersmoothie Let me know if this plugin can be merged or if I have something to change, Thanks

hipstersmoothie · 2023-02-24T18:42:42Z

@jBouyoud sorry! been reviewing this and keep getting pulled away. will try to get in ttoday

hipstersmoothie

I think we can revert all the changes to core and still have a working plugin

hipstersmoothie · 2022-05-20T19:45:32Z

.circleci/config.yml

@@ -78,7 +78,7 @@ jobs:
          at: ~/auto
      - run:
          name: Check for SemVer Label
-          command: yarn auto pr-check --url $CIRCLE_BUILD_URL
+          command: yarn auto pr-check -vv --url $CIRCLE_BUILD_URL


Revert this

hipstersmoothie · 2022-05-20T19:45:51Z

auto.config.ts

@@ -32,6 +32,7 @@ const brewOptions: IBrewPluginOptions = {
 export default function rc(): AutoRc {
  return {
    plugins: [
+      "one-release-commit",


revert this

hipstersmoothie · 2022-05-20T19:47:42Z

plugins/one-release-commit/README.md

@@ -0,0 +1,29 @@
+# One-Release-Commit Plugin
+
+Allow to create a single release commit


Write a better description of why someone might want to use this plugin.

hipstersmoothie · 2023-02-22T20:58:01Z

plugins/one-release-commit/src/index.ts

+
+      if (commits.length > 0) {
+        await execPromise("git", ["reset", "--soft", remoteHead]);
+        await execPromise("git", ["commit", "-m", this.options.commitMessage || `"Release version ${version} [skip ci]"`, "--no-verify"]);


Make sure to include skip-ci even if there is a custom message

hipstersmoothie · 2023-02-24T18:56:25Z

packages/core/src/auto.ts

@@ -1760,8 +1775,12 @@ export default class Auto {
      dryRun: options.dryRun,
      quiet: options.quiet,
    });
+
+    // New new version must be computed, so make release context
+    const releaseArgs = await this.makeReleaseContext();


This is problematic I think. For the default usage this would included the commit for the changelog in the release notes since it would now be in the commitsInRelease. Could you make sure this doesn't augment the normal auto workflow?

The changes below to for makeRelaeaseContext make sense and are good additions but the change in order has me worried.

hipstersmoothie · 2023-02-24T19:01:47Z

plugins/one-release-commit/src/index.ts

+      const commits = await auto.git.getGitLog(remoteHead);
+      const tags: ITag[] = (await Promise.all(commits.map(commit => getTag(commit.hash)))).filter(tag => tag !== undefined) as ITag[];
+
+      auto.logger.log.info(`Rewrote ${commits.length} release commits into a single commit for version [${version}] with tags: [${tags.map(tag => tag.name).join(", ")}]`);


Wait you only need the version for these logs? I don't think that a big enough reason to change core at all.

This log also seems a little early. Nothing happens until the if statement body

hipstersmoothie · 2023-02-24T19:07:37Z

packages/core/src/auto.ts

    this.logger.verbose.info("Calling after version hook");
-    await this.hooks.afterVersion.promise({ dryRun: options.dryRun });
+    await this.hooks.afterVersion.promise({ dryRun: options.dryRun, version: releaseArgs.newVersion });


OH I see why you do all of this rearranging. in the afterVersion hook if it's not a dry run it IS a release. We don't have to care about the return value of makeRelease. The undefined that it returns is for it's other usage. Here we know a release (and thus a version) has happened.

You can revert all the changes to core and remove references in you plugin to version and it still all works!

intuit-svc added the minor Increment the minor version when merged label Mar 22, 2022

jBouyoud force-pushed the one-release-commit branch from 6c46da3 to 3f0f4b2 Compare March 23, 2022 06:33

jBouyoud marked this pull request as ready for review March 23, 2022 07:33

jBouyoud force-pushed the one-release-commit branch 2 times, most recently from 77bc527 to ce747e0 Compare March 24, 2022 07:06

jBouyoud mentioned this pull request Mar 25, 2022

Feat add afterRun hook #2182

Merged

6 tasks

Procorners approved these changes Mar 25, 2022

View reviewed changes

jBouyoud force-pushed the one-release-commit branch from ce747e0 to 393e844 Compare May 31, 2022 09:34

jBouyoud force-pushed the one-release-commit branch 2 times, most recently from 7e7ab35 to 640fe0a Compare February 8, 2023 10:40

hipstersmoothie closed this Feb 8, 2023

hipstersmoothie reopened this Feb 8, 2023

jBouyoud force-pushed the one-release-commit branch from 640fe0a to 26a4342 Compare February 9, 2023 09:45

jBouyoud added 4 commits February 15, 2023 17:35

refactor(core): split release creation in two steps

77b5b04

First step create a release context (from release, to, newVersion) Second step use this information to really make the release

feat(core): add version in afterVersion hook

c91b4ab

feat(one-release-commit): create plugin with automation

378a78a

feat(one-release-commit): first implementation.

d325b20

jBouyoud force-pushed the one-release-commit branch from 26a4342 to d325b20 Compare February 15, 2023 16:35

hipstersmoothie requested changes Feb 24, 2023

View reviewed changes

jbrt approved these changes Apr 22, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create new plugin : one-release-commit #2180

Create new plugin : one-release-commit #2180

jBouyoud commented Mar 22, 2022 •

edited

jBouyoud commented May 31, 2022

jBouyoud commented Aug 11, 2022

jBouyoud commented Feb 8, 2023

jBouyoud commented Feb 9, 2023

jBouyoud commented Feb 10, 2023 •

edited

jBouyoud commented Feb 24, 2023

hipstersmoothie commented Feb 24, 2023

hipstersmoothie left a comment

hipstersmoothie May 20, 2022

hipstersmoothie May 20, 2022

hipstersmoothie May 20, 2022

hipstersmoothie Feb 22, 2023

hipstersmoothie Feb 24, 2023

hipstersmoothie Feb 24, 2023

hipstersmoothie Feb 24, 2023

hipstersmoothie Feb 24, 2023

		@@ -0,0 +1,29 @@
		# One-Release-Commit Plugin

		Allow to create a single release commit

Create new plugin : one-release-commit #2180

Are you sure you want to change the base?

Create new plugin : one-release-commit #2180

Conversation

jBouyoud commented Mar 22, 2022 • edited

What Changed

Why

Change Type

jBouyoud commented May 31, 2022

jBouyoud commented Aug 11, 2022

jBouyoud commented Feb 8, 2023

jBouyoud commented Feb 9, 2023

jBouyoud commented Feb 10, 2023 • edited

jBouyoud commented Feb 24, 2023

hipstersmoothie commented Feb 24, 2023

hipstersmoothie left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jBouyoud commented Mar 22, 2022 •

edited

jBouyoud commented Feb 10, 2023 •

edited