Merge branch 'main' into chore/python-3.12

meltano · Jul 19, 2023 · 90f63af · 90f63af
2 parents 07da600 + e36da21
commit 90f63af
Show file tree

Hide file tree

Showing 69 changed files with 1,109 additions and 340 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -15,7 +15,7 @@ body:
     attributes:
       label: Singer SDK Version
       description: Version of the library you are using
-      placeholder: "0.28.0"
+      placeholder: "0.30.0"
     validations:
       required: true
   - type: checkboxes

diff --git a/.github/stale.yml b/.github/stale.yml
@@ -0,0 +1,7 @@
+# This config file extends the shared Meltano GitHub org stale bot config:
+# https://github.com/meltano/.github/blob/main/.github/stale.yml
+
+_extends: .github
+
+# In most cases, this file should not be updated.
+# Updates to the stale bot config should be shared by all Meltano GitHub repositories.
diff --git a/.github/workflows/constraints.txt b/.github/workflows/constraints.txt
@@ -1,5 +1,5 @@
-pip==23.1.2
+pip==23.2
 poetry==1.5.1
 pre-commit==3.3.3
 nox==2023.4.22
-nox-poetry==1.0.2
+nox-poetry==1.0.3
diff --git a/.github/workflows/cookiecutter-e2e.yml b/.github/workflows/cookiecutter-e2e.yml
@@ -43,7 +43,7 @@ jobs:
         poetry --version
 
     - name: Setup Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4.6.1
+      uses: actions/setup-python@v4.7.0
       with:
         python-version: ${{ matrix.python-version }}
         architecture: x64

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -19,7 +19,7 @@ jobs:
       uses: actions/[email protected]
 
     - name: Set up Python
-      uses: actions/setup-python@v4.6.1
+      uses: actions/setup-python@v4.7.0
       with:
         python-version: "3.10"
 
@@ -56,4 +56,4 @@ jobs:
         file_glob: true
 
     - name: Publish
-      uses: pypa/[email protected].6
+      uses: pypa/[email protected].8
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -3,8 +3,28 @@ name: Test
 on:
   pull_request:
     types: [opened, synchronize, reopened]
+    paths:
+      - "cookiecutter/**"
+      - "samples/**"
+      - "singer_sdk/**"
+      - "tests/**"
+      - "noxfile.py"
+      - "poetry.lock"
+      - "pyproject.toml"
+      - ".github/workflows/test.yml"
+      - ".github/workflows/constraints.txt"
   push:
     branches: [main]
+    paths:
+      - "cookiecutter/**"
+      - "samples/**"
+      - "singer_sdk/**"
+      - "tests/**"
+      - "noxfile.py"
+      - "poetry.lock"
+      - "pyproject.toml"
+      - ".github/workflows/test.yml"
+      - ".github/workflows/constraints.txt"
   workflow_dispatch:
     inputs: {}
 
@@ -45,7 +65,7 @@ jobs:
         poetry --version
 
     - name: Setup Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4.6.1
+      uses: actions/setup-python@v4.7.0
       with:
         python-version: ${{ matrix.python-version }}${{ matrix.experimental && '-dev' || '' }}
         architecture: x64
@@ -103,7 +123,7 @@ jobs:
         poetry --version
 
     - name: Setup Python 3.10
-      uses: actions/setup-python@v4.6.1
+      uses: actions/setup-python@v4.7.0
       with:
         python-version: '3.10'
         architecture: x64
@@ -143,7 +163,7 @@ jobs:
         poetry --version
 
     - name: Set up Python
-      uses: actions/setup-python@v4.6.1
+      uses: actions/setup-python@v4.7.0
       with:
         python-version: '3.10'
         cache: 'pip'
@@ -179,3 +199,4 @@ jobs:
       uses: codecov/[email protected]
       with:
         fail_ci_if_error: true
+        token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.github/workflows/version_bump.yml b/.github/workflows/version_bump.yml
@@ -40,7 +40,7 @@ jobs:
         fetch-depth: 0
 
     - name: Set up Python
-      uses: actions/setup-python@v4.6.1
+      uses: actions/setup-python@v4.7.0
       with:
         python-version: "3.10"
         architecture: x64

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -36,24 +36,24 @@ repos:
         )$
 
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.23.2
+  rev: 0.23.3
   hooks:
   - id: check-dependabot
   - id: check-github-workflows
   - id: check-readthedocs
 
-- repo: https://github.com/charliermarsh/ruff-pre-commit
-  rev: v0.0.272
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.0.278
   hooks:
   - id: ruff
-    args: [--fix, --exit-non-zero-on-fix]
+    args: [--fix, --exit-non-zero-on-fix, --show-fixes]
     exclude: |
       (?x)^(
         cookiecutter/.*
       )$
 
 - repo: https://github.com/psf/black
-  rev: 23.3.0
+  rev: 23.7.0
   hooks:
   - id: black
     exclude: |

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,54 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## v0.30.0 (2023-07-10)
+
+### ✨ New
+
+- [#1815](https://github.com/meltano/sdk/issues/1815) Support optional headers for OAuth request -- _**Thanks @s7clarke10!**_
+- [#1800](https://github.com/meltano/sdk/issues/1800) Publish supported python versions in `--about`
+
+### 🐛 Fixes
+
+- [#1829](https://github.com/meltano/sdk/issues/1829) Update cookiecutter copyright assignment to cookiecutter user -- _**Thanks @riordan!**_
+- [#1826](https://github.com/meltano/sdk/issues/1826) Serialization of `decimal.Decimal`
+- [#1827](https://github.com/meltano/sdk/issues/1827) Add explicit dependency on `packaging` library
+- [#1820](https://github.com/meltano/sdk/issues/1820) Include SCHEMA message count in target logs
+
+### 📚 Documentation Improvements
+
+- [#1824](https://github.com/meltano/sdk/issues/1824) Document `RESTStream.rest_method`
+- [#1818](https://github.com/meltano/sdk/issues/1818) Update testing.md
+
+## v0.29.0 (2023-07-06)
+
+### ✨ New
+
+- [#1769](https://github.com/meltano/sdk/issues/1769) Validate parsed/transformed record against schema message
+- [#1525](https://github.com/meltano/sdk/issues/1525) Support union schemas
+
+### 🐛 Fixes
+
+- [#1809](https://github.com/meltano/sdk/issues/1809) Deserialize floats as `decimal.Decimal`
+- [#1770](https://github.com/meltano/sdk/issues/1770) Check schema has arrived before record
+- [#1796](https://github.com/meltano/sdk/issues/1796) Create batch directory if missing
+- [#1688](https://github.com/meltano/sdk/issues/1688) Incremental where clause generation from triggering TypeError -- _**Thanks @BuzzCutNorman!**_
+- [#1778](https://github.com/meltano/sdk/issues/1778) Sink schema comparison before adding metadata columns
+- [#1698](https://github.com/meltano/sdk/issues/1698) Force stream selection in tests
+- [#1775](https://github.com/meltano/sdk/issues/1775) Add tests for SQL type conversion from JSON schemas
+- [#1771](https://github.com/meltano/sdk/issues/1771) Add descriptions for `batch_config` properties
+- [#1752](https://github.com/meltano/sdk/issues/1752) Change runner scope to function for target tests
+- [#1753](https://github.com/meltano/sdk/issues/1753) Always emit a STATE message at the start of the sync process
+
+### ⚙️ Under the Hood
+
+- [#1745](https://github.com/meltano/sdk/issues/1745) Change `SQLStream.schema` into a cached property -- _**Thanks @mjsqu!**_
+
+### 📚 Documentation Improvements
+
+- [#1756](https://github.com/meltano/sdk/issues/1756) Fix invalid JSON in Stream Maps page and add `meltano.yml` tabs -- _**Thanks @mjsqu!**_
+- [#1763](https://github.com/meltano/sdk/issues/1763) Add Cloud banner
+
 ## v0.28.0 (2023-06-05)
 
 ### ✨ New

diff --git a/cookiecutter/tap-template/{{cookiecutter.tap_id}}/.pre-commit-config.yaml b/cookiecutter/tap-template/{{cookiecutter.tap_id}}/.pre-commit-config.yaml
@@ -23,7 +23,7 @@ repos:
   rev: v0.0.269
   hooks:
   - id: ruff
-    args: [--fix, --exit-non-zero-on-fix]
+    args: [--fix, --exit-non-zero-on-fix, --show-fixes]
 
 - repo: https://github.com/psf/black
   rev: 23.3.0

diff --git a/cookiecutter/tap-template/{{cookiecutter.tap_id}}/pyproject.toml b/cookiecutter/tap-template/{{cookiecutter.tap_id}}/pyproject.toml
@@ -21,7 +21,7 @@ packages = [
 
 [tool.poetry.dependencies]
 python = "<3.12,>=3.7.1"
-singer-sdk = { version="^0.28.0" }
+singer-sdk = { version="^0.30.0" }
 fs-s3fs = { version = "^1.1.1", optional = true }
 {%- if cookiecutter.stream_type in ["REST", "GraphQL"] %}
 requests = "^2.31.0"
@@ -32,7 +32,7 @@ cached-property = "^1" # Remove after Python 3.7 support is dropped
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.2.1"
-singer-sdk = { version="^0.28.0", extras = ["testing"] }
+singer-sdk = { version="^0.30.0", extras = ["testing"] }
 
 [tool.poetry.extras]
 s3 = ["fs-s3fs"]

diff --git a/...late/{{cookiecutter.tap_id}}/{%if 'Apache-2.0' == cookiecutter.license %}LICENSE{%endif%} b/...late/{{cookiecutter.tap_id}}/{%if 'Apache-2.0' == cookiecutter.license %}LICENSE{%endif%}
@@ -186,7 +186,8 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2021 Meltano
+
+   Copyright {% now 'utc', '%Y' %} {{ cookiecutter.admin_name }}
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/...d}}/.github/workflows/{% if cookiecutter.include_ci_files == 'GitHub' %}test.yml{%endif%} b/...d}}/.github/workflows/{% if cookiecutter.include_ci_files == 'GitHub' %}test.yml{%endif%}
@@ -1,7 +1,7 @@
 ### A CI workflow template that runs linting and python testing
 ### TODO: Modify as needed or as desired.
 
-name: Test {{cookiecutter.tap_id}}
+name: Test {{cookiecutter.target_id}}
 
 on: [push]
 

diff --git a/cookiecutter/target-template/{{cookiecutter.target_id}}/.pre-commit-config.yaml b/cookiecutter/target-template/{{cookiecutter.target_id}}/.pre-commit-config.yaml
@@ -23,7 +23,7 @@ repos:
   rev: v0.0.269
   hooks:
   - id: ruff
-    args: [--fix, --exit-non-zero-on-fix]
+    args: [--fix, --exit-non-zero-on-fix, --show-fixes]
 
 - repo: https://github.com/psf/black
   rev: 23.3.0

diff --git a/cookiecutter/target-template/{{cookiecutter.target_id}}/pyproject.toml b/cookiecutter/target-template/{{cookiecutter.target_id}}/pyproject.toml
@@ -21,15 +21,15 @@ packages = [
 
 [tool.poetry.dependencies]
 python = "<3.12,>=3.7.1"
-singer-sdk = { version="^0.28.0" }
+singer-sdk = { version="^0.30.0" }
 fs-s3fs = { version = "^1.1.1", optional = true }
 {%- if cookiecutter.serialization_method != "SQL" %}
 requests = "^2.31.0"
 {%- endif %}
 
 [tool.poetry.dev-dependencies]
 pytest = "^7.2.1"
-singer-sdk = { version="^0.28.0", extras = ["testing"] }
+singer-sdk = { version="^0.30.0", extras = ["testing"] }
 
 [tool.poetry.extras]
 s3 = ["fs-s3fs"]

diff --git a/...e/{{cookiecutter.target_id}}/{%if 'Apache-2.0' == cookiecutter.license %}LICENSE{%endif%} b/...e/{{cookiecutter.target_id}}/{%if 'Apache-2.0' == cookiecutter.license %}LICENSE{%endif%}
@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2021 Meltano
+   Copyright {% now 'utc', '%Y' %} {{ cookiecutter.admin_name }}
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

diff --git a/docs/classes/typing/singer_sdk.typing.Constant.rst b/docs/classes/typing/singer_sdk.typing.Constant.rst
@@ -0,0 +1,8 @@
+singer_sdk.typing.Constant
+==========================
+
+.. currentmodule:: singer_sdk.typing
+
+.. autoclass:: Constant
+    :members:
+    :special-members: __init__, __call__
diff --git a/docs/classes/typing/singer_sdk.typing.DiscriminatedUnion.rst b/docs/classes/typing/singer_sdk.typing.DiscriminatedUnion.rst
@@ -0,0 +1,8 @@
+singer_sdk.typing.DiscriminatedUnion
+====================================
+
+.. currentmodule:: singer_sdk.typing
+
+.. autoclass:: DiscriminatedUnion
+    :members:
+    :special-members: __init__, __call__
diff --git a/docs/classes/typing/singer_sdk.typing.OneOf.rst b/docs/classes/typing/singer_sdk.typing.OneOf.rst
@@ -0,0 +1,8 @@
+singer_sdk.typing.OneOf
+=======================
+
+.. currentmodule:: singer_sdk.typing
+
+.. autoclass:: OneOf
+    :members:
+    :special-members: __init__, __call__
diff --git a/docs/cli_commands.md b/docs/cli_commands.md
@@ -161,7 +161,7 @@ plugins:
   extractors:
   - name: my-tap
     namespace: my_tap
-    executable: ./my-tap.sh
+    executable: -e .
     capabilities:
     - state
     - catalog

diff --git a/docs/conf.py b/docs/conf.py
@@ -26,7 +26,7 @@
 author = "Meltano Core Team and Contributors"
 
 # The full version, including alpha/beta/rc tags
-release = "0.28.0"
+release = "0.30.0"
 
 
 # -- General configuration ---------------------------------------------------
@@ -42,6 +42,7 @@
     "sphinx_copybutton",
     "myst_parser",
     "sphinx_reredirects",
+    "sphinx_inline_tabs",
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/docs/reference.rst b/docs/reference.rst
@@ -92,9 +92,11 @@ JSON Schema builder classes
     typing.PropertiesList
     typing.ArrayType
     typing.BooleanType
+    typing.Constant
     typing.CustomType
     typing.DateTimeType
     typing.DateType
+    typing.DiscriminatedUnion
     typing.DurationType
     typing.EmailType
     typing.HostnameType
@@ -104,6 +106,7 @@ JSON Schema builder classes
     typing.JSONPointerType
     typing.NumberType
     typing.ObjectType
+    typing.OneOf
     typing.Property
     typing.RegexType
     typing.RelativeJSONPointerType