autorel 2.2.5 → 2.2.7

package/README.md

@@ -35,6 +35,8 @@ _Currently only has built-in support for `GitHub` and `NPM`, but you can write y
 - Comprehensive test coverage
 - Less broken builds and more time to focus on your code!
 
+[Read our FAQ on why you should use `autorel` and how it compares to other tools](docs/faq.md)
+
 # Table of Contents
 
 - [Example Usage (CLI)](#example-usage-cli)
@@ -74,7 +76,9 @@ autorel --publish
 
 ## Avoiding Breaking Changes
 
-You may want to add the version number to the npx command to prevent breaking changes in the future. For example, `npx autorel@^2 --publish --run 'echo "Next version is ${NEXT_VERSION}"'`
+If using the `npx` command, you may want to append the version number to prevent breaking changes in the future. You can do this by appending `@^` followed by the major version number.
+
+Example: `npx autorel@^2`
 
 # Example Usage (Library)
 

package/dist/lib/git.d.ts

@@ -4,6 +4,16 @@ export type Commit = {
 };
 export declare function gitFetchTags(): void;
 export declare function createAndPushTag(tag: string): void;
+/**
+ * Get the last tag. It does this by:
+ * 1. Getting all tags
+ * 2. Filtering out tags that are not in the format v1.2.3
+ * 3. Sorting the tags by version number by tricking the sort -V command by appending an
+ *   underscore to tags that do not have a hyphen in them (i.e. they are not pre-release tags)
+ *   Thanks to this StackOverflow answer: https://stackoverflow.com/questions/40390957/how-to-sort-semantic-versions-in-bash
+ * 4. Removing the underscore from the sorted tags
+ * 5. Getting the last tag
+ */
 export declare function getLastTag(): string;
 export declare function getLastProdTag(): string;
 export declare function getRepo(): {

package/dist/lib/git.js

@@ -11,8 +11,18 @@ function createAndPushTag(tag) {
     (0, sh_1.$) `git push origin ${tag}`;
 }
 exports.createAndPushTag = createAndPushTag;
+/**
+ * Get the last tag. It does this by:
+ * 1. Getting all tags
+ * 2. Filtering out tags that are not in the format v1.2.3
+ * 3. Sorting the tags by version number by tricking the sort -V command by appending an
+ *   underscore to tags that do not have a hyphen in them (i.e. they are not pre-release tags)
+ *   Thanks to this StackOverflow answer: https://stackoverflow.com/questions/40390957/how-to-sort-semantic-versions-in-bash
+ * 4. Removing the underscore from the sorted tags
+ * 5. Getting the last tag
+ */
 function getLastTag() {
-    return (0, sh_1.$) `git tag | grep -E '^v[0-9]+\.[0-9]+\.[0-9]+' | sort -V | tail -n 1` || '';
+    return (0, sh_1.$) `git tag | grep -E '^v[0-9]+\.[0-9]+\.[0-9]+' | sed '/-/!s/$/_/' | sort -V | sed 's/_$//' | tail -n 1` || '';
 }
 exports.getLastTag = getLastTag;
 function getLastProdTag() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "autorel",
-  "version": "2.2.5",
+  "version": "2.2.7",
   "description": "Automate semantic releases based on conventional commits. Similar to semantic-release but much simpler.",
   "license": "MIT",
   "author": "Marc H. Weiner <mhweiner234@gmail.com> (https://mhweiner.com)",