release-assist - npm Package Compare versions

Comparing version 1.0.2 to 2.0.0

CHANGELOG.md

@@ -0,1 +1,5 @@
+# 2.0.0 (2020-10-15)
+
+- This tool no longer git-tags the release and doesn't try to push commits to the origin (that part was too flaky).
+
 # 1.0.2 (2018-06-14)
@@ -2,0 +6,0 @@

lib/git.js

@@ -88,17 +88,5 @@ const childProcess = require("child_process");
     })
-    .then(() => {
-      return execute("git push origin master");
-    })
     .then(task.done);
 };
 
-const tagRelease = (version, changes) => {
-  const task = log.taskStart("Tagging the release");
-  return execute(`git tag -a ${version} -m "${changes}"`)
-    .then(() => {
-      return execute(`git push origin ${version}`);
-    })
-    .then(task.done);
-};
-
 module.exports = {
@@ -111,4 +99,3 @@ ensureCurrentBranchIs,
   getCommitMessagesSinceLastRelease,
-  commitRelease,
-  tagRelease
+  commitRelease
 };

lib/release_finish.js

@@ -16,8 +16,4 @@ const git = require("./git");
     .then(() => {
-      const releaseChanges = changelog.extractRelease(versionOfRelease);
-      return git.tagRelease(versionOfRelease, releaseChanges.text);
+      log.success(`Release ${versionOfRelease} commited!`);
     })
-    .then(() => {
-      log.success(`Release ${versionOfRelease} done!`);
-    })
     .catch(err => {
@@ -24,0 +20,0 @@ log.failure(err.message);

package.json

 {
   "name": "release-assist",
-  "version": "1.0.2",
-  "description": "Helps you releasing new versions of your node.js and frontend projects",
+  "version": "2.0.0",
+  "description": "Small help with new releases of your node.js and frontend projects",
   "main": "index.js",
@@ -6,0 +6,0 @@ "bin": "bin.js",

README.md

 # release-assist
 
-Helps you releasing new versions of your node.js and frontend projects.
+Small help with new releases of your node.js and frontend projects.
 
 You may consider using it if...
 
-- You're maintaining any node.js or frontend project.
-- That project uses git.
-- You're sick of doing repetitive tasks required for every new release (bumping the version, editing changelog, git-tagging the release). Release-assist helps automating those steps.
+- You're maintaining any node.js or frontend project that uses semantic versioning.
+- You use git.
+- You're sick of doing repetitive tasks required for every new release, like bumping the version and editing changelog. Release-assist helps automating those steps.
 
-![](http://szwacz.com/cd/release-assist.gif)
-
 ## Installation
@@ -21,3 +19,3 @@
 
-Or if you're like me and doesn't like any globally installed crap, add it directly to the project:
+Or if you're like me and you don't like any globally installed crap, add it directly to the project:
 
@@ -50,6 +48,6 @@ ```
 1.  Do checks that your local repository is on correct branch and in sync with origin repository, so you know no mistake happened and you didn't miss any commits done by your teammates.
-2.  Will ask you for new version number.
-3.  Will prepare new release entry in `CHANGELOG.md` with commit messages since the last release.
+2.  Will help you decide what semver-complaint version this release should have.
+3.  Will prepare new release entry in `CHANGELOG.md` with all commit messages since the last release.
 
-The changelog state release-assist left you with is most probably not final, but now your job of manually editing the changelog to give it the final form is much simpler.
+The changelog state release-assist leaves you with is most probably not final, but now your job of manually editing the changelog to give it the final form is much easier.
 
@@ -62,14 +60,8 @@ After you're done with the changelog run command:
 
-This will:
+This commits the local changes with proper version number as a commit message, so with next release this tool can keep track of everything. Now we're done here, do the real release of your project!
 
-1.  Commit the changes as a release (with new version as commit message).
-2.  Create git tag for the new release.
-3.  Push release and newly created tag to origin repository.
-
-Done! The release is ready. It took 60 seconds instead of 5 minutes, and you're sure that freakin' version tag has been pushed to origin and remembering about pushing it didn't slip your mind 4th time this month.
-
 ## Integrating into existing projects
 
 1.  This tool expects the changelog file to be named `CHANGELOG.md`, if your is called differently you need to change the name (or subit a github issue to see what we can do).
-2.  This tool expects that `CHANGELOG.md` have very specific structure (after all the script must be able to parse this file). See changelog of this project as an example. Parsing script expects release header to be in format `# version (YYYY-MM-DD)` below the header everything is treated as release description until next header is spotted.
+2.  This tool expects that `CHANGELOG.md` have very specific structure (after all we need to parse this file). See changelog of this project as an example. Parsing script expects release header to be in format `# version (YYYY-MM-DD)` below the header everything is treated as release description until next header is spotted.
 3.  The release commit need to have commit message `x.x.x` (just the version number) if you have given those commits different messages in the past then release-assist won't be able to find previous release and fill changelog with all commits of your project, but this will happen only once (for the first release done with release-assist), after that everything will be working as intended.
@@ -76,0 +68,0 @@

No alert changes

Worsened metrics

Total package byte prevSize

18020

decreased by-3.15%

Lines of code

457

decreased by-3.38%

Number of lines in readme file

69

decreased by-10.39%

No dependency changes