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

separate code generation and docs generation #4061

Merged
merged 5 commits into from
Oct 9, 2020

Conversation

megan07
Copy link
Contributor

@megan07 megan07 commented Oct 6, 2020

Fixes hashicorp/terraform-provider-google#7374

This PR allows separation of code generation and docs generation when needed. This will allow us to generate ga-code for TPG and beta-docs for TPG.

If this PR is for Terraform, I acknowledge that I have:

  • Searched through the issue tracker for an open issue that this either resolves or contributes to, commented on it to claim it, and written "fixes {url}" or "part of {url}" in this PR description. If there were no relevant open issues, I opened one and commented that I would like to work on it (not necessary for very small changes).
  • Generated Terraform, and ran make test and make lint to ensure it passes unit and linter tests.
  • Ensured that all new fields I added that can be set by a user appear in at least one example (for generated resources) or third_party test (for handwritten resources or update tests).
  • Ran relevant acceptance tests (If the acceptance tests do not yet pass or you are unable to run them, please let your reviewer know).
  • Read the Release Notes Guide before writing my release note below.

Release Note Template for Downstream PRs (will be copied)


@google-cla google-cla bot added the cla: yes label Oct 6, 2020
compiler.rb Outdated
@@ -86,6 +88,12 @@
opt.on('-d', '--debug', 'Show all debug logs') do |_debug|
Google::LOGGER.level = Logger::DEBUG
end
opt.on('-c', '--code', 'Generate code only') do
Copy link
Contributor

Choose a reason for hiding this comment

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

Would you consider doing this in the opposite direction? default to true, with flags for "--no-code" and "--no-docs"? I know it's a nitpick but that feels more consistent to me and more readable in scripts. Generally speaking a --flag adds behavior unless it starts with --no.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ndmckinley - i think i made the change you were looking for, let me know if i misinterpreted. thanks!!

Copy link
Contributor

@nat-henderson nat-henderson left a comment

Choose a reason for hiding this comment

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

Looks great. How are you planning to test the downstream generation?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Copy TPGB docs to TPG repo
2 participants