Merge branch 'feature/tag-option'.

Author: lu0

README.md

@@ -46,9 +46,9 @@ OPTIONS:
        -s | --subdir   Subfolder to be cloned.
 
        -t | --token    Path to your access token (for private repos).
-       -u | --user     Your username (for private repos).
 
        -b | --branch   Branch to be fetched.
+       -v | --tag      Tag of the version to be fetched.
        -d | --depth    Number of commits to be fetched.
 ```
 
@@ -71,12 +71,10 @@ You will need to generate an access token in order to clone private repositories
 - Github: [github.com/settings/tokens](https://github.com/settings/tokens).
 - Gitlab: [gitlab.com/-/profile/personal_access_tokens](https://gitlab.com/-/profile/personal_access_tokens).
 
-Save your token in a file and provide its path with the `--token` option, then provide your username with the `--user` option.
-
-The following example would clone a subfolder of a private repository.
+Save your token in a file and provide its path with the `--token` option, the following example would clone a subfolder of a private repository.
 ```zsh
 git-partial-clone --owner=owner --repo=repo --subdir=path/to/subdir \
-    --token=/path/to/your/token/file --user=username_with_access
+    --token=/path/to/your/token/file
 ```
 
 # Using a configuration file
@@ -105,13 +103,16 @@ Fill in the config file ([`template.conf`](./template.conf)) with the informatio
 ### Variables for **private repositories**
 - `TOKEN_PATH`:
     - Path to the file containing the access token.
-- `GIT_USER`:
-    - Username with access to the repository.
 
 ### Optional variables
 - `BRANCH`:
     - The branch to be fetched.
     - Omit it to pull all of the branches and switch to the default one.
+    - Overrided by `TAG_NAME`.
+- `TAG_NAME`:(tag | t)
+    - Tag of the version to be fetched.
+    - Omit it to fetch the latest commit of `BRANCH`.
+    - Takes precedence over `BRANCH`.
 - `COMMIT_DEPTH`:
     - Number of commits you want to fetch (useful for deployment purposes).
     - Omit it to fetch the entire remote history.

completion-rules.sh

@@ -40,10 +40,14 @@ _git-partial-clone()
             return
             ;;
         --owner | -o | --repo | -r | --subdir | -s | \
-        --user | -u | --branch | -b | --depth | -d )
+        --branch | -b | --depth | -d | \
+        --tag | -v)
             # Suggest nothing :P
             return
             ;;
+        --tag | -v)
+            return
+            ;;
         --help*)
             return
             ;;

example.conf

@@ -13,9 +13,9 @@ REPO_NAME=vscode-settings
 REMOTE_PARTIAL_DIR=json/snippets
 
 TOKEN_PATH=
-GIT_USER=
 
 BRANCH=master
+TAG_NAME=
 COMMIT_DEPTH=3
 
 PARENT_DIR=tmp