Skip to content

chore(devcontainer): add multi-arch development container support#1354

Merged
JP-Ellis merged 6 commits intopact-foundation:mainfrom
Nikhil172913832:fixing_issue_407
Dec 2, 2025
Merged

chore(devcontainer): add multi-arch development container support#1354
JP-Ellis merged 6 commits intopact-foundation:mainfrom
Nikhil172913832:fixing_issue_407

Conversation

@Nikhil172913832
Copy link
Copy Markdown
Contributor

@Nikhil172913832 Nikhil172913832 commented Nov 20, 2025

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes Setup Dev Containers #407) and the maintainers have approved on my working plan.

Summary

Adds Development Container configuration to provide a consistent development environment for contributors. Includes:

  • .devcontainer/Containerfile with multi-architecture support (x86_64/amd64 and arm64)
  • .devcontainer/devcontainer.json with VS Code extensions (Python, Pylance, Ruff) and settings
  • .devcontainer/.dockerignore to optimize build performance
  • Essential build tools: git, curl, wget, build-essential, libffi-dev, hatch
  • Automatic setup: git submodule initialization and hatch environment creation

Breaking Changes

None.

Motivation

Development containers lower the barrier to contributions by providing a pre-configured environment with all necessary dependencies. This addresses issue #407 by:

  • Eliminating manual setup for Python tooling and virtual environments
  • Supporting both x86_64 and arm64 architectures
  • Working seamlessly with GitHub Codespaces and VS Code Dev Containers
  • Ensuring consistent development experience across all platforms

Test Plan

  • Built container successfully for both amd64 and arm64 using docker buildx build --platform linux/amd64,linux/arm64
  • Verified all dependencies install correctly (git, hatch, cffi, libffi-dev)
  • Ran existing test suite to confirm no regressions:
    • tests/test_error.py: 6/6 tests passed
    • tests/test_util.py: 29/29 tests passed
    • tests/test_pact.py: 21/21 tests passed (1 skipped)
  • Tested container functionality: Python 3.13, hatch commands, workspace mounting

Related issues/PRs

Closes #407

Copilot AI review requested due to automatic review settings November 20, 2025 08:27
@codecov
Copy link
Copy Markdown

codecov bot commented Nov 20, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 51%. Comparing base (0b5892f) to head (4bd42ed).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files 
@@         Coverage Diff          @@
##           main   #1354   +/-   ##
====================================
  Coverage    51%     51%           
====================================
  Files        31      31           
  Lines      3729    3729           
====================================
  Hits       1938    1938           
  Misses     1791    1791
Flag Coverage Δ
tests 51% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copilot AI reviewed Nov 20, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds Development Container configuration to provide a consistent development environment across all platforms. The implementation includes a multi-architecture Containerfile, VS Code-specific configuration with Python tooling (Ruff, Pylance, pytest), and build optimization through .dockerignore.

Key changes:

  • Multi-arch development container based on Python 3.13-slim with essential build tools
  • VS Code integration with Python extensions and formatting/linting settings
  • Automated environment setup via postCreateCommand for git submodules and hatch

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
.devcontainer/Containerfile Defines the container image with Python 3.13, build tools, and hatch installation via pipx
.devcontainer/devcontainer.json Configures VS Code extensions, Python settings, workspace mount, and post-creation commands
.devcontainer/.dockerignore Excludes development artifacts and cache directories from the container build context

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

JP-Ellis
JP-Ellis requested changes Dec 2, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@JP-Ellis JP-Ellis left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! Sorry I didn't get time to review this earlier.

There's two really minor nits, up to you whether you want to fix them up, or I can fix them for you 👍

@Nikhil172913832
Copy link
Copy Markdown
Contributor Author

Nikhil172913832 commented Dec 2, 2025

Thanks for the review. I will make the necessary changes.

@JP-Ellis JP-Ellis merged commit bf54b8c into pact-foundation:main Dec 2, 2025
56 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@JP-Ellis JP-Ellis JP-Ellis approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Setup Dev Containers

3 participants

@Nikhil172913832 @JP-Ellis