Bump version to 3.2a1

jacebrowning · Mar 9, 2022 · c9228d2 · c9228d2
1 parent e912553
commit c9228d2
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+# 3.2 (alpha)
+
+- Added support for locking dependencies to specific versions.
+
 # 3.1 (2022-02-23)
 
 - Updated `--force-interactive` prompt to default to keeping changes.

diff --git a/docs/interfaces/api.md b/docs/interfaces/api.md
@@ -82,13 +82,14 @@ with optional arguments:
 - `*names`: optional list of dependency source or group names to filter on
 - `root`: specifies the path to the root working tree
 
-with specific revision per source:
-
-- Each item in name may be followed by @git_rev or @git_branch or @git_tag.
-- Example:
-  - `*names = ["<source1>@<sha_rev>", <source2>@<tag>", "<source3>"]`.
-  - Source1 and source2 will be locked to sha_rev and tag if they exist in the repository,
-    source3 will be locked to the currently checked out revision.
+and specific versions per source:
+
+- Each name may be followed by `@<sha>`, `@<branch>`, or `@<tag>`
+- For example:
+    - `*names = ["source1@abc123", source2@v1.0", "source3"]`
+    - `source1` will be locked to the `abc123` SHA if it exists
+    - `source2` will be locked to the `v1.0` tag if it exists
+    - `source3` will be locked to the currently checked out version
 
 ## Uninstall
 

diff --git a/docs/interfaces/cli.md b/docs/interfaces/cli.md
@@ -146,14 +146,18 @@ To restore the exact versions previously checked out, run:
 $ gitman install
 ```
 
-To lock a source to a specific revision
+### Version Pinning
+
+To lock a dependency to a specific version:
+
 ```
-$gitman lock <name1>@<sha_rev>
+$ gitman lock <name1>@<sha_rev>
 ```
 
-To lock a source to latest revision of a specific tag or branch
+or to lock a source to latest revision of a specific tag or branch:
+
 ```
-$gitman lock <name1>@<git_tag_or_branch>
+$ gitman lock <name1>@<git_tag_or_branch>
 ```
 
 ## Uninstall

diff --git a/gitman/models/config.py b/gitman/models/config.py
@@ -192,7 +192,6 @@ def _split_name_and_rev(cls, name_rev):
 
     @classmethod
     def _remap_names_and_revs(cls, names):
-
         name_rev_map = {}
 
         for name in names:

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,7 +1,7 @@
 [tool.poetry]
 
 name = "gitman"
-version = "3.1"
+version = "3.2a1"
 description = "A language-agnostic dependency manager using Git."
 
 license = "MIT"