Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs gen Makefile target for hybrid providers #321

Merged
merged 3 commits into from
Feb 3, 2023

Conversation

guineveresaenger
Copy link
Contributor

Hybrid providers are terraform-bridged Pulumi providers that have native resources added to them.
Our currently only example of this is the Pulumi Docker Provider.
All native resources need to generate their own documentation, and this PR encodes the process into any hybrid
provider Makefile.
The provider's config.yaml will need to contain the docsCmd field as well as the hybrid field in order to
generate a Makefile with a docs target.
See also: pulumi/pulumi-docker#479

  • Add logic to add a docs Makefile target
  • generalize approach to denote a hybrid provider rather than docekr specifically
  • Generate all providers. Updates major version for Fastly but does not add any extra targets to non-hybrid providers, as expected.

This addition supports Makefile changes introduced to pulumi-docker
in pulumi/pulumi-docker#479.
… add any extra targets to non-hybrid providers, as expected.
@guineveresaenger guineveresaenger requested review from danielrbradley, iwahbe and a team February 3, 2023 21:52
@guineveresaenger guineveresaenger self-assigned this Feb 3, 2023
@guineveresaenger guineveresaenger added this to the 0.84 milestone Feb 3, 2023
Copy link
Member

@iwahbe iwahbe left a comment

Choose a reason for hiding this comment

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

LGTM

@guineveresaenger guineveresaenger merged commit aa64da2 into master Feb 3, 2023
@guineveresaenger guineveresaenger deleted the docker-makefile branch February 3, 2023 22:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants