initial commit

Author: cunla

.gitignore

@@ -0,0 +1 @@
+.idea

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 D Software Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,57 @@
+# GitHub Action - Setup and Cache Python Poetry
+
+This action simplifies the setup and caching of Poetry,
+and provides the following functionality for GitHub Actions users:
+
+When a job using this action runs for the first time, this action will download Poetry and the required project
+dependencies, then save it to the cache.
+
+For the following runs (whether it's on a different
+workflow/job [with the same cached commit](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache))
+this action will restore the cache, which is much faster than downloading everything again.
+
+## Basic Usage
+
+* Make sure you have `pyproject.toml`, `poetry.lock`.
+
+```yaml
+name: ci
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      # Deal with environment setup and caching      
+      - name: Check out the repository
+        uses: actions/checkout@v4
+      - name: "Setup Python, Poetry and Dependencies"
+        uses: dsoftwareinc/setup-python-poetry-action@v1
+        with:
+          python-version: 3.11
+          poetry-version: 1.7.1
+
+      # Run what you want in the poetry environment
+      - name: Run tests
+        run: |
+          poetry run python manage.py test
+```
+
+## Notes
+
+* You can see the list of cache entries by going to:
+  `Repo` -> `Actions` tab -> `Caches` under `Managements` (left navbar, at the bottom).
+* [Don't forget the limitation of cache](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy).
+
+## Dependencies
+
+* Python setup using [`actions/setup-python`](https://github.com/actions/setup-python).
+* Poetry install using [`snok/install-poetry`](https://github.com/snok/install-poetry).
+* Poetry binary and dependency caching using [`actions/cache`](https://github.com/actions/cache).
+
+## License
+
+The scripts and documentation in this project are released under the [MIT License](LICENSE).

action.yml

@@ -0,0 +1,55 @@
+name: "Setup Python Poetry with Cache"
+description: "Setup Python & Poetry, using cache for dependencies and Poetry installation."
+branding:
+  icon: "play"
+  color: "purple"
+
+inputs:
+  python-version:
+    description: Python Version
+    required: true
+  poetry-version:
+    description: Poetry Version
+    required: true
+
+runs:
+  using: "composite"
+  steps:
+    - name: Set up python ${{ inputs.python-version }}
+      id: setup-python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.python-version }}
+
+    # Install Poetry
+    - name: Load cached Poetry Binary
+      id: cached-poetry-binary
+      uses: actions/cache@v3
+      with:
+        path: ~/.local
+        key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ inputs.poetry-version }}
+
+    - name: Install Poetry
+      uses: snok/install-poetry@v1
+      with:
+        version: ${{ inputs.poetry-version }}
+        virtualenvs-create: true
+        virtualenvs-in-project: true
+
+    # Load cached venv if cache exists
+    - name: Load cached venv
+      id: cached-poetry-dependencies
+      uses: actions/cache@v3
+      with:
+        path: .venv
+        key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
+        # If the exact match is not found, the cache will be restored from the key with the prefix.
+        # Note cache-hit returns false in this case, so the below step will run
+        restore-keys: |
+          venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-
+
+    # Install dependencies on cache miss
+    - name: Install dependencies
+      if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+      shell: sh
+      run: poetry install --no-interaction --no-root