Skip to content

ci(deps): open Dependabot pull requests for pinned versions - #326

Merged
aghassemlouei merged 1 commit into
google:mainfrom
digitalresistor:ci/dependabot
Oct 21, 2026
Merged

aghassemlouei merged 1 commit into
google:mainfrom
digitalresistor:ci/dependabot

Conversation

@digitalresistor

@digitalresistor digitalresistor commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

Description

This change has Dependabot open pull requests for pinned versions, so CI validates every update before it merges.

No issue exists for this change.

The new .github/dependabot.yml file checks these manifests every week.

  • The GitHub Actions SHA pins in every workflow under .github/workflows/.
  • The uv lock files in the cli/ project and the repository root.
  • The python base image in the analytics blueprint Dockerfile.
  • The package.json file of the fedramp-high cloud-functions blueprint.

Each entry follows the same rules.

  • A 14-day cooldown matches the repository rule to pick versions at least two weeks old. Security updates skip the cooldown.
  • Minor and patch updates arrive as one grouped pull request per entry, and each major update gets its own pull request.
  • The ci and build commit prefixes produce titles such as ci(deps): bump ... that pass the semantic-pr.yml title check and stay out of the CHANGELOG.
  • Labels stay empty, because Dependabot's default dependencies label is not part of the curated label set from ci(labels): align labeler, release-please, and issue template labels #312. The labeler.yml workflow still labels the pull requests by path.

A new tests/test_dependabot.py test fails when a tracked uv.lock, Dockerfile or package.json file has no Dependabot entry, or when an entry drops the cooldown, the prefix rules or the empty labels.

Scope notes:

  • Terraform provider versions stay out of scope. The default-versions.tf file sets them for every versions.tf copy, and tools/lint.sh expects the copies to match it, so per-directory Dependabot bumps would conflict with that model.
  • The requirements.txt files of the analytics and gem4gov-cli blueprints list no versions, so Dependabot has nothing to update there.
  • The tflint_version input in the ci.yml workflow is not a manifest that Dependabot reads.

Merge order

These four pull requests share one merge order. Merge them in this sequence.

  1. style(tests): format test_label_taxonomy.py with ruff #324 makes the ruff check step pass on main again. Every other pull request needs it for a green CI run.
  2. build(tools): run the repository tooling on a locked uv Python 3.14 environment #323 adds the root uv.lock file. Rebase it onto main after style(tests): format test_label_taxonomy.py with ruff #324 merges, which drops its copy of the style(tests): format test_label_taxonomy.py with ruff #324 commit.
  3. ci(deps): open Dependabot pull requests for pinned versions #326 adds Dependabot. Its root uv entry needs the uv.lock file from build(tools): run the repository tooling on a locked uv Python 3.14 environment #323.
  4. chore(repo): point .git-blame-ignore-revs at the #302 squash commit #325 fixes .git-blame-ignore-revs. It only needs style(tests): format test_label_taxonomy.py with ruff #324 for a green CI run, so it can merge at any point after style(tests): format test_label_taxonomy.py with ruff #324.

This pull request is step 3. Until #323 merges, Dependabot reports an update error for the root uv directory only.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Deployment & Compliance Impact

  • Applicable Regimes:
    • US Region Restricted (e.g., Access Policy constraint)
    • FedRAMP Moderate
    • FedRAMP High
    • DoD IL4
    • DoD IL5
    • General / All
  • NIST 800-53r5 Controls: SI-2 flaw remediation and CM-2 baseline configuration. Dependabot proposes patched versions as reviewable pull requests instead of changing the baseline silently.

Checklist

Code Quality & Reusability

  • My code adheres to the Maximize Reusability principle. I have not redefined common elements and have reused existing base configurations and modules where possible.
  • I have checked that no existing module or configuration in modules/ or fast/stages-aw/ can be leveraged for this change.
  • My code follows the established naming conventions outlined in docs/naming-convention.md.

Documentation

  • I have updated the README.md of the modified module or blueprint.
  • I have added/updated documentation for inputs (variables) and outputs.

Security

  • My change adheres to GCP security best practices and the principle of least privilege.
  • I have ensured compliance with the targeted regime (FedRAMP Moderate, FedRAMP High, IL4, IL5, etc.).

Testing

  • I have tested my changes locally.
  • I have included details of my testing in this PR.

Testing Performed

Command Result
check-jsonschema --builtin-schema vendor.dependabot .github/dependabot.yml Valid
pytest tests/test_dependabot.py on Python 3.11, the python-tests job version on main 3 passed
ruff check and ruff format --check with ruff 0.17.1 on tests/test_dependabot.py Clean
check_boilerplate.py on both new files Clean

Not verified:

  • Dependabot only runs after the file reaches the default branch, so no Dependabot pull request exists yet.

Dependabot now checks the GitHub Actions SHA pins, the uv lock files, the analytics blueprint base image and the cloud-functions blueprint package.json every week, and opens a pull request so CI validates each update. Every entry waits 14 days after a release to match the repository rule for new versions, groups minor and patch updates, and uses build or ci title prefixes that pass the semantic PR check. A test fails when a tracked uv.lock, Dockerfile or package.json has no Dependabot entry.

@aghassemlouei aghassemlouei left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Verified .github/dependabot.yml coverage across GitHub Actions, root and cli/ uv.lock, the analytics Dockerfile, and the Cloud Functions package.json, along with the 14-day cooldown, silent commit prefixes, empty label list, and tests/test_dependabot.py unit tests.

@aghassemlouei
aghassemlouei merged commit f913204 into google:main Oct 21, 2026
16 checks passed
@aghassemlouei aghassemlouei added Dependencies - GitHub Actions Pull requests that update GitHub Actions workflows and actions Enhancement New feature or request Level of Effort - Low Quick, well-defined tasks with no unknowns; takes a few hours up to one day to complete Priority - Low Minor polish, typo fixes, or technical debt; nice to have; pick up when time permits labels Oct 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Dependencies - GitHub Actions Pull requests that update GitHub Actions workflows and actions Enhancement New feature or request Level of Effort - Low Quick, well-defined tasks with no unknowns; takes a few hours up to one day to complete Priority - Low Minor polish, typo fixes, or technical debt; nice to have; pick up when time permits

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants