-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create standalone package
- Loading branch information
Showing
32 changed files
with
4,647 additions
and
1,204 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
# An action for setting up poetry install with caching. | ||
# Using a custom action since the default action does not | ||
# take poetry install groups into account. | ||
# Action code from: | ||
# https://github.com/actions/setup-python/issues/505#issuecomment-1273013236 | ||
name: poetry-install-with-caching | ||
description: Poetry install with support for caching of dependency groups. | ||
|
||
inputs: | ||
python-version: | ||
description: Python version, supporting MAJOR.MINOR only | ||
required: true | ||
|
||
poetry-version: | ||
description: Poetry version | ||
required: true | ||
|
||
cache-key: | ||
description: Cache key to use for manual handling of caching | ||
required: true | ||
|
||
working-directory: | ||
description: Directory whose poetry.lock file should be cached | ||
required: true | ||
|
||
runs: | ||
using: composite | ||
steps: | ||
- uses: actions/setup-python@v4 | ||
name: Setup python ${{ inputs.python-version }} | ||
with: | ||
python-version: ${{ inputs.python-version }} | ||
|
||
- uses: actions/cache@v3 | ||
id: cache-bin-poetry | ||
name: Cache Poetry binary - Python ${{ inputs.python-version }} | ||
env: | ||
SEGMENT_DOWNLOAD_TIMEOUT_MIN: "1" | ||
with: | ||
path: | | ||
/opt/pipx/venvs/poetry | ||
# This step caches the poetry installation, so make sure it's keyed on the poetry version as well. | ||
key: bin-poetry-${{ runner.os }}-${{ runner.arch }}-py-${{ inputs.python-version }}-${{ inputs.poetry-version }} | ||
|
||
- name: Refresh shell hashtable and fixup softlinks | ||
if: steps.cache-bin-poetry.outputs.cache-hit == 'true' | ||
shell: bash | ||
env: | ||
POETRY_VERSION: ${{ inputs.poetry-version }} | ||
PYTHON_VERSION: ${{ inputs.python-version }} | ||
run: | | ||
set -eux | ||
# Refresh the shell hashtable, to ensure correct `which` output. | ||
hash -r | ||
# `actions/cache@v3` doesn't always seem able to correctly unpack softlinks. | ||
# Delete and recreate the softlinks pipx expects to have. | ||
rm /opt/pipx/venvs/poetry/bin/python | ||
cd /opt/pipx/venvs/poetry/bin | ||
ln -s "$(which "python$PYTHON_VERSION")" python | ||
chmod +x python | ||
cd /opt/pipx_bin/ | ||
ln -s /opt/pipx/venvs/poetry/bin/poetry poetry | ||
chmod +x poetry | ||
# Ensure everything got set up correctly. | ||
/opt/pipx/venvs/poetry/bin/python --version | ||
/opt/pipx_bin/poetry --version | ||
- name: Install poetry | ||
if: steps.cache-bin-poetry.outputs.cache-hit != 'true' | ||
shell: bash | ||
env: | ||
POETRY_VERSION: ${{ inputs.poetry-version }} | ||
PYTHON_VERSION: ${{ inputs.python-version }} | ||
run: pipx install "poetry==$POETRY_VERSION" --python "python$PYTHON_VERSION" --verbose | ||
|
||
- name: Restore pip and poetry cached dependencies | ||
uses: actions/cache@v3 | ||
env: | ||
SEGMENT_DOWNLOAD_TIMEOUT_MIN: "4" | ||
WORKDIR: ${{ inputs.working-directory == '' && '.' || inputs.working-directory }} | ||
with: | ||
path: | | ||
~/.cache/pip | ||
~/.cache/pypoetry/virtualenvs | ||
~/.cache/pypoetry/cache | ||
~/.cache/pypoetry/artifacts | ||
${{ env.WORKDIR }}/.venv | ||
key: py-deps-${{ runner.os }}-${{ runner.arch }}-py-${{ inputs.python-version }}-poetry-${{ inputs.poetry-version }}-${{ inputs.cache-key }}-${{ hashFiles(format('{0}/**/poetry.lock', env.WORKDIR)) }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
name: lint | ||
|
||
on: | ||
workflow_call: | ||
inputs: | ||
working-directory: | ||
required: true | ||
type: string | ||
description: "From which folder this pipeline executes" | ||
|
||
env: | ||
POETRY_VERSION: "1.6.1" | ||
WORKDIR: ${{ inputs.working-directory == '' && '.' || inputs.working-directory }} | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
env: | ||
# This number is set "by eye": we want it to be big enough | ||
# so that it's bigger than the number of commits in any reasonable PR, | ||
# and also as small as possible since increasing the number makes | ||
# the initial `git fetch` slower. | ||
FETCH_DEPTH: 50 | ||
strategy: | ||
matrix: | ||
# Only lint on the min and max supported Python versions. | ||
# It's extremely unlikely that there's a lint issue on any version in between | ||
# that doesn't show up on the min or max versions. | ||
# | ||
# GitHub rate-limits how many jobs can be running at any one time. | ||
# Starting new jobs is also relatively slow, | ||
# so linting on fewer versions makes CI faster. | ||
python-version: | ||
- "3.8" | ||
- "3.11" | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- name: Set up Python ${{ matrix.python-version }} + Poetry ${{ env.POETRY_VERSION }} | ||
uses: "./.github/actions/poetry_setup" | ||
with: | ||
python-version: ${{ matrix.python-version }} | ||
poetry-version: ${{ env.POETRY_VERSION }} | ||
working-directory: ${{ inputs.working-directory }} | ||
cache-key: lint-with-extras | ||
|
||
- name: Check Poetry File | ||
shell: bash | ||
working-directory: ${{ inputs.working-directory }} | ||
run: | | ||
poetry check | ||
- name: Check lock file | ||
shell: bash | ||
working-directory: ${{ inputs.working-directory }} | ||
run: | | ||
poetry lock --check | ||
- name: Install dependencies | ||
# Also installs dev/lint/test/typing dependencies, to ensure we have | ||
# type hints for as many of our libraries as possible. | ||
# This helps catch errors that require dependencies to be spotted, for example: | ||
# https://github.com/langchain-ai/langchain/pull/10249/files#diff-935185cd488d015f026dcd9e19616ff62863e8cde8c0bee70318d3ccbca98341 | ||
# | ||
# If you change this configuration, make sure to change the `cache-key` | ||
# in the `poetry_setup` action above to stop using the old cache. | ||
# It doesn't matter how you change it, any change will cause a cache-bust. | ||
working-directory: ${{ inputs.working-directory }} | ||
run: | | ||
poetry install --with dev,lint,test,typing | ||
- name: Get .mypy_cache to speed up mypy | ||
uses: actions/cache@v3 | ||
env: | ||
SEGMENT_DOWNLOAD_TIMEOUT_MIN: "2" | ||
with: | ||
path: | | ||
${{ env.WORKDIR }}/.mypy_cache | ||
key: mypy-${{ runner.os }}-${{ runner.arch }}-py${{ matrix.python-version }}-${{ inputs.working-directory }}-${{ hashFiles(format('{0}/poetry.lock', env.WORKDIR)) }} | ||
|
||
- name: Analysing the code with our lint | ||
working-directory: ${{ inputs.working-directory }} | ||
run: | | ||
make lint |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
name: pydantic v1/v2 compatibility | ||
|
||
on: | ||
workflow_call: | ||
inputs: | ||
working-directory: | ||
required: true | ||
type: string | ||
description: "From which folder this pipeline executes" | ||
|
||
env: | ||
POETRY_VERSION: "1.6.1" | ||
|
||
jobs: | ||
build: | ||
timeout-minutes: 5 | ||
defaults: | ||
run: | ||
working-directory: ${{ inputs.working-directory }} | ||
runs-on: ubuntu-latest | ||
strategy: | ||
matrix: | ||
python-version: | ||
- "3.8" | ||
- "3.9" | ||
- "3.10" | ||
- "3.11" | ||
name: Pydantic v1/v2 compatibility - Python ${{ matrix.python-version }} | ||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
- name: Set up Python ${{ matrix.python-version }} + Poetry ${{ env.POETRY_VERSION }} | ||
uses: "./.github/actions/poetry_setup" | ||
with: | ||
python-version: ${{ matrix.python-version }} | ||
poetry-version: ${{ env.POETRY_VERSION }} | ||
working-directory: ${{ inputs.working-directory }} | ||
cache-key: pydantic-cross-compat | ||
|
||
- name: Install dependencies | ||
shell: bash | ||
run: poetry install | ||
|
||
- name: Install the opposite major version of pydantic | ||
# If normal tests use pydantic v1, here we'll use v2, and vice versa. | ||
shell: bash | ||
run: | | ||
# Determine the major part of pydantic version | ||
REGULAR_VERSION=$(poetry run python -c "import pydantic; print(pydantic.__version__)" | cut -d. -f1) | ||
if [[ "$REGULAR_VERSION" == "1" ]]; then | ||
PYDANTIC_DEP=">=2.1,<3" | ||
TEST_WITH_VERSION="2" | ||
elif [[ "$REGULAR_VERSION" == "2" ]]; then | ||
PYDANTIC_DEP="<2" | ||
TEST_WITH_VERSION="1" | ||
else | ||
echo "Unexpected pydantic major version '$REGULAR_VERSION', cannot determine which version to use for cross-compatibility test." | ||
exit 1 | ||
fi | ||
# Install via `pip` instead of `poetry add` to avoid changing lockfile, | ||
# which would prevent caching from working: the cache would get saved | ||
# to a different key than where it gets loaded from. | ||
poetry run pip install "pydantic${PYDANTIC_DEP}" | ||
# Ensure that the correct pydantic is installed now. | ||
echo "Checking pydantic version... Expecting ${TEST_WITH_VERSION}" | ||
# Determine the major part of pydantic version | ||
CURRENT_VERSION=$(poetry run python -c "import pydantic; print(pydantic.__version__)" | cut -d. -f1) | ||
# Check that the major part of pydantic version is as expected, if not | ||
# raise an error | ||
if [[ "$CURRENT_VERSION" != "$TEST_WITH_VERSION" ]]; then | ||
echo "Error: expected pydantic version ${CURRENT_VERSION} to have been installed, but found: ${TEST_WITH_VERSION}" | ||
exit 1 | ||
fi | ||
echo "Found pydantic version ${CURRENT_VERSION}, as expected" | ||
- name: Run pydantic compatibility tests | ||
shell: bash | ||
run: make test | ||
|
||
- name: Ensure the tests did not create any additional files | ||
shell: bash | ||
run: | | ||
set -eu | ||
STATUS="$(git status)" | ||
echo "$STATUS" | ||
# grep will exit non-zero if the target message isn't found, | ||
# and `set -e` above will cause the step to fail. | ||
echo "$STATUS" | grep 'nothing to commit, working tree clean' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
name: release | ||
|
||
on: | ||
workflow_call: | ||
inputs: | ||
working-directory: | ||
required: true | ||
type: string | ||
description: "From which folder this pipeline executes" | ||
|
||
env: | ||
POETRY_VERSION: "1.6.1" | ||
|
||
jobs: | ||
if_release: | ||
# Disallow publishing from branches that aren't `main`. | ||
if: github.ref == 'refs/heads/main' | ||
runs-on: ubuntu-latest | ||
permissions: | ||
# This permission is used for trusted publishing: | ||
# https://blog.pypi.org/posts/2023-04-20-introducing-trusted-publishers/ | ||
# | ||
# Trusted publishing has to also be configured on PyPI for each package: | ||
# https://docs.pypi.org/trusted-publishers/adding-a-publisher/ | ||
id-token: write | ||
|
||
# This permission is needed by `ncipollo/release-action` to create the GitHub release. | ||
contents: write | ||
defaults: | ||
run: | ||
working-directory: ${{ inputs.working-directory }} | ||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
- name: Set up Python + Poetry ${{ env.POETRY_VERSION }} | ||
uses: "./.github/actions/poetry_setup" | ||
with: | ||
python-version: "3.10" | ||
poetry-version: ${{ env.POETRY_VERSION }} | ||
working-directory: ${{ inputs.working-directory }} | ||
cache-key: release | ||
|
||
- name: Build project for distribution | ||
run: poetry build | ||
- name: Check Version | ||
id: check-version | ||
run: | | ||
echo version=$(poetry version --short) >> $GITHUB_OUTPUT | ||
- name: Create Release | ||
uses: ncipollo/release-action@v1 | ||
with: | ||
artifacts: "dist/*" | ||
token: ${{ secrets.GITHUB_TOKEN }} | ||
draft: false | ||
generateReleaseNotes: true | ||
tag: v${{ steps.check-version.outputs.version }} | ||
commit: main | ||
- name: Publish package distributions to PyPI | ||
uses: pypa/gh-action-pypi-publish@release/v1 | ||
with: | ||
packages-dir: ${{ inputs.working-directory }}/dist/ | ||
verbose: true | ||
print-hash: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
name: test | ||
|
||
on: | ||
workflow_call: | ||
inputs: | ||
working-directory: | ||
required: true | ||
type: string | ||
description: "From which folder this pipeline executes" | ||
|
||
env: | ||
POETRY_VERSION: "1.6.1" | ||
|
||
jobs: | ||
build: | ||
defaults: | ||
run: | ||
working-directory: ${{ inputs.working-directory }} | ||
runs-on: ubuntu-latest | ||
strategy: | ||
matrix: | ||
python-version: | ||
- "3.8" | ||
- "3.9" | ||
- "3.10" | ||
- "3.11" | ||
name: Python ${{ matrix.python-version }} | ||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
- name: Set up Python ${{ matrix.python-version }} + Poetry ${{ env.POETRY_VERSION }} | ||
uses: "./.github/actions/poetry_setup" | ||
with: | ||
python-version: ${{ matrix.python-version }} | ||
poetry-version: ${{ env.POETRY_VERSION }} | ||
working-directory: ${{ inputs.working-directory }} | ||
cache-key: core | ||
|
||
- name: Install dependencies | ||
shell: bash | ||
run: poetry install | ||
|
||
- name: Run core tests | ||
shell: bash | ||
run: make test | ||
|
||
- name: Ensure the tests did not create any additional files | ||
shell: bash | ||
run: | | ||
set -eu | ||
STATUS="$(git status)" | ||
echo "$STATUS" | ||
# grep will exit non-zero if the target message isn't found, | ||
# and `set -e` above will cause the step to fail. | ||
echo "$STATUS" | grep 'nothing to commit, working tree clean' |
Oops, something went wrong.