Release v1.4.0 (#19)

Author: connesy

.github/workflows/run_tests.yml

@@ -5,8 +5,9 @@ name: Linting and tests
 
 on:
   push:
-    branches: [ "main", "release/*" ]
+    branches: [ "main" ]
   pull_request:
+    branches: [ "main", "release/**", "develop" ]
 
 permissions:
   contents: read

CHANGELOG.md

@@ -2,9 +2,15 @@
 
 ## [Unreleased](https://github.com/SallingGroup-AI-and-ML/venv-cli/tree/develop)
 
+## [v1.4.0](https://github.com/SallingGroup-AI-and-ML/venv-cli/releases/tag/v1.4.0) (2023-10-30)
+
+### 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

@@ -9,7 +9,7 @@ _yellow="\033[01;33m"
 _red="\033[31m"
 
 # Version number has to follow pattern "^v\d+\.\d+\.\d+.*$"
-_version="v1.3.0"
+_version="v1.4.0"
 
 # Valid VCS URL environment variable pattern
 # https://peps.python.org/pep-0610/#specification
@@ -167,8 +167,8 @@ venv::install() {
   if venv::_check_if_help_requested "$1"; then
     echo "venv install [<requirements file>] [--skip-lock] [<install args>]"
     echo
-    echo "Install requirements from <requirements file>, like 'requirements.txt'"
-    echo "or 'requirements.lock'."
+    echo "Clear the environment, then install requirements from <requirements file>,"
+    echo "like 'requirements.txt' or 'requirements.lock'."
     echo "Installed packages are then locked into the corresponding .lock-file,"
     echo "e.g. 'venv install requirements.txt' will lock packages into 'requirements.lock'."
     echo "This step is skipped if '--skip-lock' is specified, or when installing"
@@ -211,6 +211,10 @@ venv::install() {
     shift
   fi
 
+  # Clear the environment before running pip install to avoid orphaned packages
+  # https://github.com/SallingGroup-AI-and-ML/venv-cli/issues/9
+  venv::clear
+
   venv::color_echo "${_green}" "Installing requirements from ${requirements_file}"
   if ! pip install --require-virtualenv --use-pep517 -r "${requirements_file}" "$@"; then
     return "${_fail}"
@@ -301,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'."
@@ -318,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