Merge branch 'release/v1.2.0'

Author: connesy

.github/workflows/run_tests.yml

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

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [v1.2.0](https://github.com/SallingGroup-AI-and-ML/venv-cli/releases/tag/v1.2.0) (2023-08-04)
+
+From this release forward, this project follows the `Git Flow` branching model. To reflect this, the default development branch have been renamed `develop`, and the `main` branch is now only for tagged releases.
+To read more about Git Flow, see (https://nvie.com/posts/a-successful-git-branching-model/). Also see [README](https://github.com/SallingGroup-AI-and-ML/venv-cli/blob/v1.2.0/README.md#git-flow) for branch naming conventions.
+
+* Changed github test workflow to reflect new branch naming conventions.
+* Added better, context-based bash completions.
+
 ## [v1.1.0](https://github.com/SallingGroup-AI-and-ML/venv-cli/releases/tag/v1.1.0) (2023-08-02)
 
 ### New install script

README.md

@@ -162,13 +162,26 @@ As this is meant to be a lightweight tool providing simple, QoL improvements to
 
 That said, pull requests are welcome. For bigger changes, please open an issue first to discuss what you would like to change.
 
-To contribute, clone the repo, create a virtual environment (preferably using `venv-cli`) and install `dev-requirements.txt`. When you are done with your changes, run the test suite with
+To contribute, clone the repo and create a branch, create a virtual environment (preferably using `venv-cli`) and install `dev-requirements.txt`. When you are done with your changes, run the test suite with
 ```console
 $ pytest .
 ```
+then create a pull request for the `develop` branch.
 
 Every subcommand has its own test file `tests/test_venv_<command>.py` Please make sure to add/update tests as appropriate.
 
+### Git Flow
+This project follows the [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) branching model. The default development branch is accordingly named `develop`, and the branch `main` is reserved for tagged releases and hotfixes. Other branches should be named according to their purpose:
+```
+feature/<branch name>
+bugfix/<branch name>
+release/<branch name>
+hotfix/<branch name>
+support/<branch name>
+```
+
+Releases are made by creating a branch `release/vX.X.X` from `develop`, where `X.X.X` represents the release version number, following [SemVer](https://semver.org/). This freezes the version number of **this release**, and no more features from `develop` should be merged into this release (only `bugfix/`). When the `release/` branch is ready for release, merge it into `main` and tag the commit with the release version, then merge the `release/` branch back into `develop` (resolving any merge conflicts) to get the bugfixes included there as well.
+
 ## License
 
 [MIT](https://choosealicense.com/licenses/mit/)

src/venv-cli/completions/bash/venv_completion.sh

@@ -1,18 +1,73 @@
 # bash completion for venv                                -*- shell-script -*-
 
 _venv() {
-    local cur_word prev_word subcommands fill_list
+    local cur_word prev_word _subcommands subcommands help_options
     cur_word="${COMP_WORDS[COMP_CWORD]}"
     prev_word="${COMP_WORDS[COMP_CWORD-1]}"
-    subcommands="create activate install lock clear sync deactivate -V --version"
-    command_options="-h --help"
 
-    if [ "${prev_word}" == "venv" ]; then
-        fill_list="${subcommands} ${command_options}"
-    else
-        fill_list="${command_options}"
+    _subcommands="activate clear create deactivate install lock sync"
+    subcommands=( $(compgen -W "${_subcommands}" -- "${cur_word}") )
+    help_options=( $(compgen -W "-h --help" -- "${cur_word}") )
+
+    # Generate completions for subcommand options
+    compopt -o nosort
+    case "${prev_word}" in
+        "venv")
+            # If only 'venv' has been entered, generate list of subcommands and options
+            COMPREPLY+=( ${subcommands[*]} )
+            COMPREPLY+=( ${help_options[*]} )
+
+            local version_options
+            version_options=( $(compgen -W "-V --version" -- "${cur_word}") )
+            COMPREPLY+=( ${version_options[*]} )
+            ;;
+        "create")
+            # Generate list of all available python3 versions
+
+            # The command below does the following, by line:
+            # * List all python commands, e.g. "python3", "python3.10-config", ...
+            # * Select only "python3.X" or "python3.XX"
+            # * Remove the "python", leaving the version number
+            # * Select unique entries, sorted by numerical value
+            local python_versions
+            python_versions=( $( \
+                    compgen -c "python${cur_word}" \
+                    | grep -P '^python3.\d+$' \
+                    | sed 's|python||' \
+                    | sort -n --unique \
+                ) )
+            COMPREPLY+=( ${python_versions[*]} )
+            COMPREPLY+=( ${help_options[*]} )
+            ;;
+        "install"|"lock")
+            # Generate completions for requirement and lock file paths
+            COMPREPLY+=( $(compgen -f -X '!(*.txt|*.lock)' -- "${cur_word}" | sort) )
+            COMPREPLY+=( ${help_options[*]} )
+            compopt -o plusdirs +o nosort  # Add directories after generated completions
+            ;;
+        "sync")
+            # Generate completions for lock file paths
+            COMPREPLY+=( $(compgen -f -X '!*.lock' -- "${cur_word}" | sort) )
+            COMPREPLY+=( ${help_options[*]} )
+            compopt -o plusdirs +o nosort  # Add directories after generated completions
+            ;;
+        "activate"|"deactivate"|"clear")
+            # Only generate help options
+            COMPREPLY+=( ${help_options[*]} )
+            ;;
+        "-V"|"--version")
+            # Nothing to generate
+            ;;
+        *)
+            # Nothing to generate
+            ;;
+    esac
+
+    # Special case for 'venv lock requirements.txt <TAB>', where only *.lock files should be suggested
+    if [ "${COMP_WORDS[COMP_CWORD-2]}" == "lock" ] && [[ "${prev_word}" =~ ^.*\.txt$ ]]; then
+        COMPREPLY+=( $(compgen -f -X '!*.lock' -- "${cur_word}" | sort) )
+        compopt -o plusdirs +o nosort  # Add directories after generated completions
     fi
-    COMPREPLY=($(compgen -W "${fill_list}" -- "${cur_word}"))
 }
 
 complete -F _venv venv

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.1.0"
+_version="v1.2.0"
 
 # Valid VCS URL environment variable pattern
 # https://peps.python.org/pep-0610/#specification