Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
95 lines (71 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

95 lines (71 loc) · 2.86 KB
Raw

Contributing

Prerequisites

Building

# Build and install the provider locally
make install

# Or step by step:
make tfgen      # Build the schema generator
make schema     # Generate schema.json and bridge-metadata.json
make provider   # Build the provider binary

Python SDK

Generate the Python SDK from the current schema:

make sdk_python

This outputs to sdk/python/. To install it locally for testing:

uv pip install -e sdk/python

Testing

# Fast schema validity test (no credentials needed)
make test_provider

# Full end-to-end integration test (requires credentials)
export DAGSTER_CLOUD_ORGANIZATION="your-org"
export DAGSTER_CLOUD_API_TOKEN="your-token"
make test_examples

The examples/basic-python/ example can be tested manually with pulumi preview after running make install and uv pip install -e sdk/python.

Project Structure

pulumi-dagsterplus/
├── .github/workflows/
│   ├── ci.yml                              # Runs on PRs and pushes to main
│   └── release.yml                         # Triggered by version tags
├── provider/
│   ├── resources.go                        # Provider configuration and token mapping
│   ├── schema_test.go                      # Schema validity test
│   └── cmd/
│       ├── pulumi-tfgen-dagsterplus/       # Schema generator binary
│       └── pulumi-resource-dagsterplus/    # Provider runtime binary
├── examples/
│   ├── basic/                              # Basic YAML example
│   ├── basic-python/                       # Basic Python example
│   └── examples_test.go                   # Integration tests
├── .goreleaser.yml                         # Cross-platform release config
└── Makefile

Releasing

Releases are automated via goreleaser and GitHub Actions. Pushing a version tag triggers the release workflow, which:

  1. Builds cross-platform provider binaries and publishes them to GitHub Releases
  2. Generates the Python SDK, builds a wheel, and publishes it to PyPI
git tag v0.1.0
git push origin v0.1.0

The PyPI publish step requires a PYPI_TOKEN secret configured in the repository's GitHub Actions settings.

Updating the Upstream Provider

When a new version of the Terraform provider is released:

  1. Update the version in go.mod: 
    github.com/dagster-io/terraform-provider-dagsterplus vX.Y.Z
  2. Run go mod tidy
  3. Run make install to regenerate the schema and rebuild
  4. Run make sdk_python to regenerate the Python SDK
  5. Run make test_provider && make test_examples to verify