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.

Sign up for GitHub

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

Jump to bottom

[docs] Implement Java constructor syntax examples #15805

Merged
merged 1 commit into from
Mar 28, 2024
Merged

[docs] Implement Java constructor syntax examples #15805

merged 1 commit into from
Mar 28, 2024

Conversation

Zaid-Ajaj
Copy link
Contributor

Description

This PR implements Java constructor syntax examples, rendering them into the docs. It upgrades pulumi-java to 0.10.0 which includes features from pulumi/pulumi-java#1338

It also updates contructor syntax generator to emit an unbound variable for resource-typed properties. We use the name of the resource as the name of the variable:

const example = new Resource("name", { pet: randomPet })

where pet is a property that is typed as random.RandomPet so it gets assigned the (unbound) variable called randomPet

Previously we would skip emitting any code for resource-typed properties. I think this gives better docs even though it doesn't compile

Checklist

  • I have run make tidy to update any new dependencies
  • I have run make lint to verify my code passes the lint check
    • I have formatted my code using gofumpt
  • I have added tests that prove my fix is effective or that my feature works
  • I have run make changelog and committed the changelog/pending/<file> documenting my change
  • Yes, there are changes in this PR that warrants bumping the Pulumi Cloud API version

@Zaid-Ajaj Zaid-Ajaj added the area/docs Improvements or additions to documentation label Mar 27, 2024
@Zaid-Ajaj Zaid-Ajaj requested a review from a team as a code owner March 27, 2024 22:45
@pulumi-bot
Copy link
Contributor

Changelog

[uncommitted] (2024-03-27)

Features

  • [docs] Implement Java constructor syntax examples
    #15805

justinvp
justinvp approved these changes Mar 27, 2024
View reviewed changes
Copy link
Member

@justinvp justinvp left a comment

Choose a reason for hiding this comment

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

LGTM

For the future, consider splitting PRs like this into separate PRs, e.g.:

  1. Unbound variable fix
  2. Upgrade Java
  3. Implement Java constructor syntax

@Zaid-Ajaj Zaid-Ajaj force-pushed the zaid/java-constructor-syntax-examples branch from b3bada1 to 8702fbb Compare March 27, 2024 23:10
@Zaid-Ajaj Zaid-Ajaj added this pull request to the merge queue Mar 28, 2024
Merged via the queue into master with commit 00b6856 Mar 28, 2024
55 checks passed
@Zaid-Ajaj Zaid-Ajaj deleted the zaid/java-constructor-syntax-examples branch March 28, 2024 01:05
@justinvp justinvp mentioned this pull request Apr 11, 2024
Merged
github-merge-queue bot pushed a commit that referenced this pull request Apr 11, 2024
@justinvp
Prepare for v3.113.0 release (#15915)
c70d4e4 
Tentative changelog:


### Features

- [cli] Support always fully qualifying stack names in CLI output
  [#15857](#15857)

- [cli] Add --no-plugins and --no-dependencies to `pulumi install`
  [#15910](#15910)

- [docs] Implement Java constructor syntax examples
  [#15805](#15805)

- [sdk/nodejs] Make TypeScript and ts-node optional peer dependencies to
allow using user specified versions
  [#15622](#15622)

- [sdk/{nodejs,python}] Allow apply to have unknown values during
updates
  [#15898](#15898)

- [sdk/python] Adds 'typeChecker' runtime option to the Python language
host
  [#15725](#15725)


### Bug Fixes

- [auto] Tolerate missing stack and bookkeeping files in ProgramTest.
  [#15863](#15863)

- [cli] Fix a panic when user's home directory could not be looked up
  [#15872](#15872)

- [cli] Fix some commands that didn't respect
`--disable-integrity-checking`

- [programgen/dotnet] Removes trailing whitespace from emitted DependsOn
resource option expressions
  [#15892](#15892)

- [auto/go] Avoid flakyness when reading the event log from pulumi
commands
  [#15856](#15856)

- [sdk/go] Fix Provider and Providers options in Go transform functions
  [#15885](#15885)

- [sdk/nodejs] Handle serialization of aliases for well known native
functions
  [#15873](#15873)

- [sdk/nodejs] Correctly serialise functions whose code would make use
of reserved identifiers
  [#15879](#15879)

- [sdk/nodejs] Serialize function values obtained from Function.bind
  [#15887](#15887)

- [sdk/python] Improve types of getters in Python SDK
  [#15865](#15865)

- [sdkgen/{dotnet,go}] Fixes SDK-generation when referencing shared
types in config variables
  [#15772](#15772)


### Miscellaneous

- [sdk/nodejs] Update builtin module list for function serialization
  [#15830](#15830)

- [sdk/nodejs] Set package.json engines to node >= 18
  [#15845](#15845)
@justinvp justinvp mentioned this pull request Apr 11, 2024
Merged
github-merge-queue bot pushed a commit that referenced this pull request Apr 12, 2024
@justinvp
Freeze v3.113.0 (#15920)
8ff72bf 
### Features

- [cli] Support always fully qualifying stack names in CLI output
  [#15857](#15857)

- [cli] Add --no-plugins and --no-dependencies to `pulumi install`
  [#15910](#15910)

- [docs] Implement Java constructor syntax examples
  [#15805](#15805)

- [sdk/nodejs] Make TypeScript and ts-node optional peer dependencies to
allow using user specified versions
  [#15622](#15622)

- [sdk/{nodejs,python}] Allow apply to have unknown values during
updates
  [#15898](#15898)

- [sdk/python] Adds 'typeChecker' runtime option to the Python language
host
  [#15725](#15725)


### Bug Fixes

- [auto] Tolerate missing stack and bookkeeping files in ProgramTest.
  [#15863](#15863)

- [cli] Fix a panic when user's home directory could not be looked up
  [#15872](#15872)

- [cli] Fix some commands that didn't respect
`--disable-integrity-checking`
  [#15911](#15911)

- [programgen/dotnet] Removes trailing whitespace from emitted DependsOn
resource option expressions
  [#15892](#15892)

- [auto/go] Avoid flakyness when reading the event log from pulumi
commands
  [#15856](#15856)

- [sdk/go] Fix Provider and Providers options in Go transform functions
  [#15885](#15885)

- [sdk/nodejs] Handle serialization of aliases for well known native
functions
  [#15873](#15873)

- [sdk/nodejs] Correctly serialise functions whose code would make use
of reserved identifiers
  [#15879](#15879)

- [sdk/nodejs] Serialize function values obtained from Function.bind
  [#15887](#15887)

- [sdk/python] Improve types of getters in Python SDK
  [#15865](#15865)

- [sdkgen/{dotnet,go}] Fixes SDK-generation when referencing shared
types in config variables
  [#15772](#15772)


### Miscellaneous

- [sdk/nodejs] Update builtin module list for function serialization
  [#15830](#15830)

- [sdk/nodejs] Set package.json engines to node >= 18
  [#15845](#15845)
@justinvp justinvp mentioned this pull request Apr 12, 2024
Merged
github-merge-queue bot pushed a commit that referenced this pull request Apr 15, 2024
@justinvp
Freeze v3.113.0 (#15928)
6210fe9 
### Features

- [auto/{go,nodejs,python}] Add support for continue-on-error parameter
of the destroy command to the Automation API
  [#15921](#15921)

- [cli] Support always fully qualifying stack names in CLI output
  [#15857](#15857)

- [cli] Add --no-plugins and --no-dependencies to `pulumi install`
  [#15910](#15910)

- [docs] Implement Java constructor syntax examples
  [#15805](#15805)

- [sdk/nodejs] Make TypeScript and ts-node optional peer dependencies to
allow using user specified versions
  [#15622](#15622)

- [sdk/{nodejs,python}] Allow apply to have unknown values during
updates
  [#15898](#15898)

- [sdk/python] Add 'typeChecker' runtime option to the Python language
host
  [#15922](#15922)
  [#15725](#15725)


### Bug Fixes

- [auto] Tolerate missing stack and bookkeeping files in ProgramTest
  [#15922](#15922)
  [#15863](#15863)

- [cli] Fix a panic when user's home directory could not be looked up
  [#15872](#15872)

- [cli] Fix some commands that didn't respect
`--disable-integrity-checking`
  [#15911](#15911)

- [programgen/dotnet] Remove trailing whitespace from emitted DependsOn
resource option expressions
  [#15922](#15922)
  [#15892](#15892)

- [auto/go] Avoid flakyness when reading the event log from pulumi
commands
  [#15856](#15856)

- [sdk/go] Fix Provider and Providers options in Go transform functions
  [#15885](#15885)

- [sdk/nodejs] Handle serialization of aliases for well known native
functions
  [#15873](#15873)

- [sdk/nodejs] Correctly serialise functions whose code would make use
of reserved identifiers
  [#15879](#15879)

- [sdk/nodejs] Serialize function values obtained from Function.bind
  [#15887](#15887)

- [sdk/python] Improve types of getters in Python SDK
  [#15865](#15865)

- [sdkgen/{dotnet,go}] Fix SDK-generation when referencing shared types
in config variables
  [#15772](#15772)
  [#15922](#15922)


### Miscellaneous

- [sdk/nodejs] Update builtin module list for function serialization
  [#15830](#15830)

- [sdk/nodejs] Set package.json engines to node >= 18
  [#15845](#15845)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@justinvp justinvp justinvp approved these changes

@cnunciato cnunciato Awaiting requested review from cnunciato

@sean1588 sean1588 Awaiting requested review from sean1588

Assignees
No one assigned
Labels
area/docs Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@Zaid-Ajaj @pulumi-bot @justinvp