Skip to content
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Default owners for everything in the repo

* @opsmill/sa
119 changes: 68 additions & 51 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,22 @@
---
name: Build and Deploy Docusaurus
name: CI
# yamllint disable rule:truthy rule:line-length
on:
pull_request:
push:
branches:
- main

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

permissions:
contents: read

env:
VALE_VERSION: "3.7.1"
UV_VERSION: "0.5.10"
VALE_VERSION: "3.13.0"
UV_VERSION: "0.9.18"
Comment on lines +18 to +19
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

# Check the file and git history to confirm previous versions
git log --oneline --all -p .github/workflows/ci.yml | head -100

Repository: opsmill/infrahub-exporter

Length of output: 2698


🌐 Web query:

UV 0.5.10 to 0.9.18 breaking changes migration guide

💡 Result:

Here’s a concise migration checklist for upgrading uv from 0.5.10 → 0.9.18 (key breaking changes and what to do). Sources cited inline.

  1. Pin / verify Python versions
  • 0.9.x changed default/available Python handling (Python 3.14 surfaced as a default/stable in 0.9.0). Pin the Python you expect (or test on 3.14) and update any CI images. If your builds rely on an implicit system Python, add explicit python-version constraints. (newreleases.io)
  1. Update build-backend bounds in pyproject.toml
  • If you have an upper bound for uv_build in [build-system], update it to a 0.9.x-compatible range (examples in docs show uv_build>=0.9.18,<0.10.0). Verify build-backend compatibility after upgrade. (docs.astral.sh)
  1. Review deprecated/changed CLI flags and commands
  • Some flags/behaviors were deprecated or changed across 0.9.x (e.g., deprecation warnings such as --project on uv init in 0.9.9). Audit scripts/automation that call uv CLI and adjust flags per current help output. Run uv -h / uv -h to detect mismatches. (github.com)
  1. uv publish and environment-variable behavior
  • Earlier versions had issues where uv publish didn’t read UV_PUBLISH_URL / UV_PUBLISH_TOKEN; test your publish workflow (and explicitly pass --publish-url/--token as a fallback). 0.9.x contains fixes/enhancements to publish handling—retest and adjust CI if necessary. (github.com)
  1. Configuration / tool settings
  • New configuration keys and flags landed across 0.9.x (example: accept --torch-backend in [tool.uv] in 0.9.18). Review your [tool.uv] config and environment variables for newly supported or renamed keys. (newreleases.io)
  1. New features that may change behavior
  • 0.9.x added features (resolver improvements, cache commands, export/sync changes, Python variant handling) that can alter resolver outcomes or CLI output — verify dependency resolution, lockfiles (uv.lock), and automation that parses uv output. Run a full install/lock and compare results. (github.com)
  1. Test matrix and CI
  • Run your full test matrix (all supported Python versions you target) under 0.9.18. Pay attention to interpreter detection changes and platform-specific messages that may affect automation. (github.com)
  1. Read the per-release notes / changelogs
  • For any remaining edge cases, consult the uv release notes / changelogs for each 0.6.x → 0.9.18 release to catch smaller breaking changes or behavioral tweaks you rely on. The project split changelogs by breaking version — use those files for detailed diffs. (git.joshthomas.dev)

If you want, I can:

  • generate a concrete changelog diff (0.5.10 → 0.9.18) with links to each release note, or
  • run a checklist against a sample pyproject.toml / CI config you paste.

Citations:


🌐 Web query:

Vale 3.7.1 to 3.13.0 breaking changes release notes

💡 Result:

Summary of notable breaking / backwards-impacting changes from Vale v3.7.1 → v3.13.0

  • Global/big breaking change (pre-v3.x you may already have encountered): v3.0 moved vocabularies from $StylesPath/Vocab → $StylesPath/config/vocabularies (users upgrading from v2→v3 must move them). [1]

  • v3.7.x → v3.7.1: bugfixes only (Julia parser added; fixes to matchToken behavior) — no breaking changes called out. [2]

  • v3.9.x: added comment-based controls (switching styles per-block; ignore individual matches). These change how inline comment config can be used and may interact with existing in-file config; not strictly breaking, but can affect behavior if you relied on older comment semantics. [3]

  • v3.10.0: built-in MDX support and a config change — it’s no longer necessary to set CommentDelimiters or use a [formats] association for Markdown. That change can alter how previously-customized Markdown/comment configurations behave. [4]

  • v3.11.0: added front-matter field linting (YAML/TOML/JSON) producing new scopes (e.g., text.frontmatter.title). This creates additional scopes that rules can target — can change matching behavior if you relied on older scope names. [5]

  • v3.12.0: introduced Views (new way to extract scoped content from structured files and source code). Views change how content is scoped/linted (can be breaking for workflows expecting the previous blueprint/format handling). [5]

  • v3.13.0: added tree-sitter support for Java source files (affects how Java files are parsed/linted); minor fixes for continuation-character errors. [6]

If you need, I can:

  • extract the exact changelog text for each release (3.8 → 3.13) or
  • produce a migration checklist (config settings to review and example changes).

Sources

  1. v3.0 breaking notes (vocab path change). [1] (newreleases.io)
  2. v3.7.1 changelog (fixes, Julia parser). [2] (newreleases.io)
  3. v3.9 (comment syntax features). [3] (newreleases.io)
  4. v3.10 (MDX support; CommentDelimiters/formats change). [4] (newreleases.io)
  5. v3.11 & v3.12 (front matter scopes; Views). [5] (github.com)
  6. v3.13 (tree-sitter Java; fixes). [6] (github.com)

Citations:


Test these tool versions for compatibility concerns.

These versions include significant changes that warrant testing:

  • UV 0.9.18: Python version handling changes, CLI flag deprecations, and resolver improvements (major jump from 0.5.x).
  • Vale 3.13.0: New scoping behavior, Views feature, and front-matter linting (includes multiple feature additions from 3.7.x).

Run the full test suite with these versions to ensure no unexpected behavior changes or build failures.

🤖 Prompt for AI Agents
.github/workflows/ci.yml lines 18-19 specify VALE_VERSION "3.13.0" and
UV_VERSION "0.9.18"; the reviewer asks these versions be validated for
compatibility. Update CI to run the full test suite with these exact tool
versions (or add a matrix job that includes them), run the test matrix
locally/CI, capture and fix any failures caused by changed CLI flags, Python
handling, resolver behavior, or Vale scoping/front-matter changes (e.g., adjust
CLI invocations, update Python compatibility layers, and modify Vale
config/rules as needed), then commit CI adjustments and any code/config fixes so
the pipeline passes with these versions.


jobs:
files-changed:
Expand All @@ -19,9 +27,9 @@ jobs:
documentation: ${{ steps.changes.outputs.documentation_all }}
python: ${{ steps.changes.outputs.python_all }}
yaml: ${{ steps.changes.outputs.yaml_all }}
markdown: ${{ steps.changes.outputs.markdown_all }}
steps:
- name: "Check out repository code"
uses: "actions/checkout@v4"
- uses: actions/checkout@v5
- name: Check for file changes
uses: opsmill/[email protected]
id: changes
Expand All @@ -32,42 +40,53 @@ jobs:
python-lint:
if: needs.files-changed.outputs.python == 'true'
needs: ["files-changed"]
runs-on: "ubuntu-latest"
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
- name: "Check out repository code"
uses: "actions/checkout@v4"
with:
submodules: true
- uses: actions/checkout@v5
- name: Install uv
uses: astral-sh/setup-uv@v4
uses: astral-sh/setup-uv@v7
with:
version: ${{ env.UV_VERSION }}
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: "Install dependencies"
run: "uv sync --frozen --group dev"
- name: "Linting: ruff check"
run: "uv run ruff check ."
- name: "Linting: ruff format"
run: "uv run ruff format --check --diff"
- run: uv sync
- name: Check code formatting
run: |
uv run ruff format --check --diff
uv run ruff check --select I .
- name: Run linters
run: uv run ruff check
- name: Run type checks
run: uv run mypy .

yaml-lint:
if: needs.files-changed.outputs.yaml == 'true'
needs: ["files-changed"]
runs-on: "ubuntu-latest"
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
- name: "Check out repository code"
uses: "actions/checkout@v4"
- uses: actions/checkout@v5
- name: Install uv
uses: astral-sh/setup-uv@v7
with:
submodules: true
- name: "Setup environment"
run: "pip install yamllint==1.35.1"
- name: "Linting: yamllint"
run: "yamllint -s ."
version: ${{ env.UV_VERSION }}
- run: uv sync
- name: Run yamllint
run: uv run yamllint -s .

markdown-lint:
if: needs.files-changed.outputs.markdown == 'true'
needs: ["files-changed"]
runs-on: ubuntu-latest
timeout-minutes: 5
steps:
- uses: actions/checkout@v5
- uses: actions/setup-node@v6
with:
node-version: 20
- name: Install markdownlint-cli
run: npm install -g markdownlint-cli
- name: Run markdownlint
run: markdownlint "**/*.{md,mdx}"

documentation:
defaults:
Expand All @@ -78,48 +97,46 @@ jobs:
!contains(needs.*.result, 'failure') &&
!contains(needs.*.result, 'cancelled') &&
needs.files-changed.outputs.documentation == 'true'
needs: ["files-changed", "yaml-lint", "python-lint"]
runs-on: "ubuntu-22.04"
needs: ["files-changed", "yaml-lint", "python-lint", "markdown-lint"]
runs-on: ubuntu-22.04
timeout-minutes: 5
steps:
- name: "Check out repository code"
uses: "actions/checkout@v4"
- uses: actions/checkout@v5
with:
submodules: true
- name: Install NodeJS
uses: actions/setup-node@v4
- uses: actions/setup-node@v6
with:
node-version: 20
cache: 'npm'
cache-dependency-path: docs/package-lock.json
- name: "Install dependencies"
- name: Install Node dependencies
working-directory: docs
run: npm install
- name: "Setup Python environment"
run: "pip install invoke toml"
- name: "Build docs website"
run: "invoke docs"
- name: Install uv
uses: astral-sh/setup-uv@v7
with:
version: ${{ env.UV_VERSION }}
- run: uv sync
working-directory: ./
- name: Build docs website
run: uv run invoke docs

validate-documentation-style:
if: |
always() && !cancelled() &&
!contains(needs.*.result, 'failure') &&
!contains(needs.*.result, 'cancelled')
needs: ["files-changed", "yaml-lint", "python-lint"]
runs-on: "ubuntu-22.04"
needs: ["files-changed", "yaml-lint", "python-lint", "markdown-lint"]
runs-on: ubuntu-22.04
timeout-minutes: 5
steps:
- name: "Check out repository code"
uses: "actions/checkout@v4"
- uses: actions/checkout@v5
with:
submodules: true

# The official GitHub Action for Vale doesn't work, installing manually instead:
# https://github.com/errata-ai/vale-action/issues/103
# Manual installation - GitHub Action is broken
- name: Download Vale
run: |
curl -sL "https://github.com/errata-ai/vale/releases/download/v${VALE_VERSION}/vale_${VALE_VERSION}_Linux_64-bit.tar.gz" -o vale.tar.gz
tar -xzf vale.tar.gz
env:
VALE_VERSION: ${{ env.VALE_VERSION }}
- name: "Validate documentation style"
run: ./vale $(find ./docs -type f \( -name "*.mdx" -o -name "*.md" \) )
- name: Validate documentation style
run: ./vale $(find ./docs/docs -type f \( -name "*.mdx" -o -name "*.md" \))
1 change: 1 addition & 0 deletions .yamllint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ extends: default
ignore: |
/.git
/.github
/.venv
/docs/node_modules

rules:
Expand Down
190 changes: 190 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,190 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to the Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

Copyright 2024 OpsMill

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
2 changes: 1 addition & 1 deletion infrahub_exporter/config.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import os
import yaml
from typing import Any

import yaml
from pydantic import BaseModel, Field
from pydantic_settings import BaseSettings

Expand Down
Loading
Loading