Add Poetry Version Option (#1)

Add Poetry Version Option

Adds an option to allow allow specifying the poetry
version in the setup-python action.

Signed-off-by: Hassan Abouelela <[email protected]>

.github/workflows/test_setup_python.yaml

@@ -126,3 +126,28 @@ jobs:
 
       - name: Test Optional Dependency
         run: python -c "import six"
+
+  versions:
+    name: Test Different Poetry Versions
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        version:
+          - "poetry==1.1.*"
+          - "poetry==1.2.*"
+          - "git+https://github.com/python-poetry/poetry.git@master"
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Python
+        uses: ./setup-python
+        with:
+          dev: false
+          python_version: 3.9
+          poetry_version: ${{ matrix.version }}
+          working_dir: setup-python/tests/
+          use_cache: false
+
+      - name: Check Installation
+        run: poetry --version

README.md

@@ -12,7 +12,7 @@ linked in the index below.
 > {name}_v{version}
 
 Example:
-> setup-python_v1.2.1
+> setup-python_v1.3.0
 
 
 ### Support Policy
@@ -33,7 +33,7 @@ An index of all the currently maintained scripts, their description, and the lat
 
 | Name                           | Version | Status                        | Description                                          |
 |--------------------------------|---------|-------------------------------|------------------------------------------------------|
-| [Setup Python](./setup-python) | 1.2.1   | [![tests][sp_badge]][sp_link] | Setup a [poetry][Poetry]-managed python environment. |
+| [Setup Python](./setup-python) | 1.3.0   | [![tests][sp_badge]][sp_link] | Setup a [poetry][Poetry]-managed python environment. |
 
 
 [License]: https://shields.io/github/license/HassanAbouelela/actions

setup-python/README.md

@@ -8,10 +8,10 @@ It also handles caching of pre-commit if you happen to be using that.
 You can use this action as follows:
 ```yaml
 - name: Install Python Dependencies
-  uses: HassanAbouelela/actions/setup-python@setup-python_v1.2.1
+  uses: HassanAbouelela/actions/setup-python@setup-python_v1.3.0
   with:
     dev: false
-    python_version: 3.9
+    python_version: '3.10'
 ```
 
 ### Inputs
@@ -21,9 +21,10 @@ The following inputs are required to use this action.
 |----------------|--------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | dev            | bool   | false   | Indicate whether dev dependencies should be installed. If false, the `--no-dev` flag is passed to poetry. Despite having a default, it's good practice to explicitly set one. |
 | python_version | string |         | Specify the python version passed to the `actions/setup-python` action.                                                                                                       |
+| poetry_version | string | poetry  | The version of poetry to install and use. This is passed directly to pip, so you can specify any pattern, such as `poetry~=1.2` or `poetry==1.1.15`.                          |
 | working_dir    | path   | `.`     | The directory to run the `poetry install` command in. By default, this will just be the root directory.                                                                       |
 | use_cache      | bool   | true    | Enable or disable the usage of cache, even if it is available.                                                                                                                |
-| install_args   | string |         | A string placed after the `poetry install` command, which can contain extra options                                                                                           |
+| install_args   | string |         | A string placed after the `poetry install` command, which can contain extra options.                                                                                          |
 
 ### Outputs
 The following outputs are produced by the action:

setup-python/action.yaml

@@ -26,6 +26,11 @@ inputs:
     required: false
     default: ""
 
+  poetry_version:
+    description: "The poetry version to install (passed to pip install)"
+    required: false
+    default: "poetry"
+
 outputs:
   cache-hit:
     description: "Was there a cache hit for the python cache."
@@ -57,8 +62,8 @@ runs:
           ~/.cache/pypoetry
           ~/.cache/py-user-base
         key: "python-${{ runner.os }}-${{ env.PYTHONUSERBASE }}-\
-        v1.2.1-\
-        ${{ steps.python_setup.outputs.python-version }}-${{ inputs.dev }}-${{ inputs.working_dir }}\
+        v1.3.0-\
+        ${{ steps.python_setup.outputs.python-version }}-${{ inputs.dev }}-${{ inputs.working_dir }}-${{ inputs.poetry_version }}\
         ${{ hashFiles('./pyproject.toml', './poetry.lock') }}"
 
     # Cache pre-commit independently of other cache
@@ -67,15 +72,15 @@ runs:
       with:
         path: ~/.cache/pre-commit
         key: "precommit-${{ runner.os }}-${{ env.PRE_COMMIT_HOME }}-\
-        v1.2.1-\
-        ${{ steps.python_setup.outputs.python-version }}-${{ inputs.dev }}-${{ inputs.working_dir }}\
+        v1.3.0-\
+        ${{ steps.python_setup.outputs.python-version }}-${{ inputs.dev }}-${{ inputs.working_dir }}-${{ inputs.poetry_version }}\
         ${{ hashFiles('./.pre-commit-config.yaml') }}"
 
     - name: Install Poetry
       shell: bash
       run: |
         echo "::group::Install Poetry"
-        pip install poetry
+        pip install ${{ inputs.poetry_version }}
         echo "::endgroup::"
 
     - name: Install dependencies
@@ -107,3 +112,4 @@ runs:
       run: |
         cd ${{ inputs.working_dir }}
         echo "$(python -m poetry env info --path)/bin" >> $GITHUB_PATH
+        python -m poetry -V

setup-python/tests/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "project"
-version = "1.2.1"
+version = "1.3.0"
 description = "Simple project to test the setup-python action."
 authors = ["Hassan Abouelela <[email protected]>"]
 license = "MIT"