Mark 'venv sync' as deprecated (#14)

Author: connesy

CHANGELOG.md

@@ -3,11 +3,12 @@
 ## [Unreleased](https://github.com/SallingGroup-AI-and-ML/venv-cli/tree/develop)
 
 ### Minor changes
+* `venv sync` command marked as deprecated with removal planned for `v2.0`. Use `venv install <requirements>.lock` instead. [#14](https://github.com/SallingGroup-AI-and-ML/venv-cli/pull/14)
 * `venv install` now runs `venv clear` before installation. This ensures that the enrivonment doesn't end up with orphaned packages after making changes to `requirements.txt`. [#9](https://github.com/SallingGroup-AI-and-ML/venv-cli/issues/9)
 
 ## [v1.3.0](https://github.com/SallingGroup-AI-and-ML/venv-cli/releases/tag/v1.3.0) (2023-10-30)
 
-## Major changes
+### Major changes
 * `venv lock` no longer tries to fill in credentials for packages installed via VCS. This behavior was undocumented and difficult to maintain and ultimately tried to alleviate a shortcoming of the way `pip` handles these credentials. [#11](https://github.com/SallingGroup-AI-and-ML/venv-cli/pull/11)
 For users who have credentials as part of URLs in their `requirements.txt` files, there are other ways to handle credentials, e.g. filling them in `requirements.lock` manually, using a `.netrc` file to store the credetials or using a keyring. See https://pip.pypa.io/en/stable/topics/authentication/ for more info.
 

src/venv-cli/venv.sh

@@ -305,7 +305,10 @@ venv::clear() {
 venv::sync() {
   if venv::_check_if_help_requested "$1"; then
     echo "venv sync [<lock file>]"
-    echo
+    echo ""
+    echo "DEPRECATED: This command is deprecated and will be removed in version 2.0."
+    echo "Use 'venv install <requirements.lock>' instead."
+    echo ""
     echo "Remove all installed packages from the environment (venv clear)"
     echo "and install all packages specified in <lock file>."
     echo "The <lock file> must be in the form '*requirements.lock'."
@@ -322,6 +325,8 @@ venv::sync() {
     return "${_success}"
   fi
 
+  venv::color_echo "${_yellow}" "DEPRECATED: This command is deprecated and will be removed in version 2.0. Use 'venv install <requirements.lock>' instead."
+
   local lock_file
   if [ -z "$1" ]; then
     # If no argument passed