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

CPLAT-9778: Update builder readme to reflect new codegen #615

Merged
merged 2 commits into from
Aug 4, 2020

Conversation

greglittlefield-wf
Copy link
Contributor

Motivation

The builder/README.md file wasn't updated when we originally implemented the new parsing/codegen to support the new mixin-based boilerplate.

Goals:

  • Update the document to reflect the new builder logic

Non-Goals

  • Revamp that document entirely
  • Go through parsing/codegen for every kind of declaration in detail

Changes

  • Update the document to reflect the new builder logic
  • Update generated code snippets
  • Update outdated boilerplate in snippets

Release Notes

Review

See CONTRIBUTING.md for more details on review types (+1 / QA +1 / +10) and code review process.

Please review:

QA Checklist

  • Markdown renders well
  • Links aren't broken

Merge Checklist

While we perform many automated checks before auto-merging, some manual checks are needed:

  • A Client Platform member has reviewed these changes
  • There are no unaddressed comments - this check can be automated if reviewers use the "Request Changes" feature
  • For release PRs - Version metadata in Rosie comment is correct

@greglittlefield-wf greglittlefield-wf changed the title Update builder readme to reflect new codegen CPLAT-9778: Update builder readme to reflect new codegen Aug 3, 2020
@aviary3-wk
Copy link

Security Insights

No security relevant content was detected by automated scans.

Action Items

  • Review PR for security impact; comment "security review required" if needed or unsure
  • Verify aviary.yaml coverage of security relevant code

Questions or Comments? Reach out on Slack: #support-infosec.

Copy link
Contributor

@corwinsheahan-wf corwinsheahan-wf left a comment

Choose a reason for hiding this comment

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

Just a couple small things

Co-authored-by: corwinsheahan-wf <[email protected]>
@corwinsheahan-wf
Copy link
Contributor

QA +1

  • CI passes (docs only change)
  • All links in changed files work and point to the correct locations.

Merging into master.
@Workiva/release-management-p

Copy link

@rmconsole-wf rmconsole-wf left a comment

Choose a reason for hiding this comment

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

+1 from RM

@rm-astro-wf rm-astro-wf merged commit 6753fef into function-components-wip Aug 4, 2020
@rm-astro-wf rm-astro-wf deleted the builder-readme branch August 4, 2020 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants