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

Define Supported Languages for Overlay Resources #3107

Merged
merged 4 commits into from
Jul 16, 2024

Conversation

flostadler
Copy link
Contributor

@flostadler flostadler commented Jul 15, 2024

Proposed changes

docsgen supports defining the supported languages of an overlay now.
This will ensure only the supported languages show up in the language choosers
in the registry.

Example for Chart v3:
Screenshot 2024-07-01 at 16 11 23

Related issues (optional)

Relates to pulumi/pulumi#13231

docsgen supports defining the supported languages for an overlay.
This will ensure only the supported languages show up in the language choosers
of the docs.
Copy link

Does the PR have any schema changes?

Looking good! No breaking changes found.
No new resources/functions.

@flostadler flostadler requested review from EronWright, rquitales and a team July 15, 2024 20:10
Copy link

codecov bot commented Jul 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.57%. Comparing base (cf02cf4) to head (ab0f7d9).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3107      +/-   ##
==========================================
- Coverage   36.60%   36.57%   -0.04%     
==========================================
  Files          71       71              
  Lines        9263     9263              
==========================================
- Hits         3391     3388       -3     
- Misses       5534     5536       +2     
- Partials      338      339       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@rquitales
Copy link
Member

rquitales commented Jul 15, 2024

I understand the scope of this PR is currently limited to Chart v3, but should we also include specifying the languages supported for the other overlays in this provider as well? apiextensions.CustomResource, kustomize (v1) and yaml (v1).

Ref:

"apiextensions/customResource.ts": mustLoadFile(filepath.Join(templateDir, "apiextensions", "customResource.ts")),
"apiextensions/customResourcePatch.ts": mustLoadFile(filepath.Join(templateDir, "apiextensions", "customResourcePatch.ts")),
"helm/v3/helm.ts": mustLoadFile(filepath.Join(templateDir, "helm", "v3", "helm.ts")),
"kustomize/kustomize.ts": mustLoadFile(filepath.Join(templateDir, "kustomize", "kustomize.ts")),
"yaml/yaml.ts": mustRenderTemplate(filepath.Join(templateDir, "yaml", "yaml.tmpl"), templateResources),

@flostadler flostadler changed the title Define Supported Languages for Chart v3 Define Supported Languages for Overlay Resources Jul 15, 2024
@flostadler
Copy link
Contributor Author

I understand the scope of this PR is currently limited to Chart v3, but should we also include specifying the languages supported for the other overlays in this provider as well? apiextensions.CustomResource, kustomize (v1) and yaml (v1).

Ref:

"apiextensions/customResource.ts": mustLoadFile(filepath.Join(templateDir, "apiextensions", "customResource.ts")),
"apiextensions/customResourcePatch.ts": mustLoadFile(filepath.Join(templateDir, "apiextensions", "customResourcePatch.ts")),
"helm/v3/helm.ts": mustLoadFile(filepath.Join(templateDir, "helm", "v3", "helm.ts")),
"kustomize/kustomize.ts": mustLoadFile(filepath.Join(templateDir, "kustomize", "kustomize.ts")),
"yaml/yaml.ts": mustRenderTemplate(filepath.Join(templateDir, "yaml", "yaml.tmpl"), templateResources),

@rquitales Good point, I updated the PR!

@flostadler flostadler self-assigned this Jul 15, 2024
@flostadler flostadler merged commit 17cb1fa into master Jul 16, 2024
19 checks passed
@flostadler flostadler deleted the flostadler/helmv3-overlay-languages branch July 16, 2024 16:47
@EronWright
Copy link
Contributor

@flostadler I should mention that the Java SDK does in fact have CustomResource support; see #3020. If you have a bit of time, could you open a PR to fix the apiextensionsCustomResource and apiextensionsCustomResourcePatch entries to include Java.

I would also argue that "csharp" is NOT a supported language for CustomResource. Yes we have a CustomResource class in the .NET SDK, but it doesn't have a public constructor because it is intended to be subclassed, not used directly as is the case with the other SDKs.

Thanks!

flostadler added a commit that referenced this pull request Jul 23, 2024
Java is supported for `CustomResource` and `CustomResourcePatch`. This
change adds it to the list of supported languages for the overlays. See
#3107 (comment)
for context
@mjeffryes mjeffryes added this to the 0.107 milestone Jul 24, 2024
blampe added a commit that referenced this pull request Aug 7, 2024
### Added

- `clusterIdentifier` configuration can now be used to manually control
the replacement behavior of a provider resource.
(#3068)

- Pod errors now include the pod's last termination state, as well as
the pod's termination message if available.
(#3091)

The pod's termination message can be helpful in `CrashLoopBackOff`
situations but will only be reported if it was correctly configured.

By default, the pod's termination message is read from
`/dev/termination-log`. This location can be configured with
`terminationMessagePath`.

Use `terminationMessagePolicy: FallbackToLogsOnError` to use the pod's
logs as its termination message.

- Documentation is now generated for all languages supported by overlay
types. (#3107)

### Fixed

- Updated logic to accurately detect if a resource is a Patch variant.
(#3102)
- Added Java as a supported language for `CustomResource` overlays.
(#3120)
- Status messages reported during updates are now more accurately scoped
to the
affected resource.
(#3128)
- `PersistentVolumeClaims` with a bind mode of `WaitForFirstConsumer`
will no
longer hang indefinitely.
(#3130)
- [java] Fixed an issue where child resources could not be registered by
Chart v4. (#3119)
lumiere-bot bot referenced this pull request in coolguy1771/home-ops Aug 8, 2024
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@pulumi/kubernetes](https://pulumi.com)
([source](https://togithub.com/pulumi/pulumi-kubernetes)) | dependencies
| minor | [`4.15.0` ->
`4.16.0`](https://renovatebot.com/diffs/npm/@pulumi%2fkubernetes/4.15.0/4.16.0)
|

---

### Release Notes

<details>
<summary>pulumi/pulumi-kubernetes (@&#8203;pulumi/kubernetes)</summary>

###
[`v4.16.0`](https://togithub.com/pulumi/pulumi-kubernetes/blob/HEAD/CHANGELOG.md#4160-August-7-2024)

[Compare
Source](https://togithub.com/pulumi/pulumi-kubernetes/compare/v4.15.0...v4.16.0)

##### Added

- `clusterIdentifier` configuration can now be used to manually control
the
replacement behavior of a provider
resourc[https://github.com/pulumi/pulumi-kubernetes/pull/3068](https://togithub.com/pulumi/pulumi-kubernetes/pull/3068)ull/3068)

- Pod errors now include the pod's last termination state, as well as
the pod's
termination message if
availabl[https://github.com/pulumi/pulumi-kubernetes/pull/3091](https://togithub.com/pulumi/pulumi-kubernetes/pull/3091)ull/3091)

The pod's termination message can be helpful in `CrashLoopBackOff`
situations but
    will only be reported if it was correctly configured.

    By default, the pod's termination message is read from
    `/dev/termination-log`. This location can be configured with
    `terminationMessagePath`.

Use `terminationMessagePolicy: FallbackToLogsOnError` to use the pod's
logs
    as its termination message.

- Documentation is now generated for all languages supported by overlay
types.

[https://github.com/pulumi/pulumi-kubernetes/pull/3107](https://togithub.com/pulumi/pulumi-kubernetes/pull/3107)3107)

##### Fixed

- Updated logic to accurately detect if a resource is a Patch variant.
([https://github.com/pulumi/pulumi-kubernetes/pull/3102](https://togithub.com/pulumi/pulumi-kubernetes/pull/3102))
- Added Java as a supported language for `CustomResource` overlays.
([https://github.com/pulumi/pulumi-kubernetes/pull/3120](https://togithub.com/pulumi/pulumi-kubernetes/pull/3120))
- Status messages reported during updates are now more accurately scoped
to the
affected
resourc[https://github.com/pulumi/pulumi-kubernetes/pull/3128](https://togithub.com/pulumi/pulumi-kubernetes/pull/3128)3128)
- `PersistentVolumeClaims` with a bind mode of `WaitForFirstConsumer`
will no
longer hang
indefinitel[https://github.com/pulumi/pulumi-kubernetes/pull/3130](https://togithub.com/pulumi/pulumi-kubernetes/pull/3130)3130)
- \[java] Fixed an issue where child resources could not be registered
by Chart v4.
[https://github.com/pulumi/pulumi-kubernetes/pull/3119](https://togithub.com/pulumi/pulumi-kubernetes/pull/3119)9)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Renovate
Bot](https://togithub.com/renovatebot/renovate).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC4yMS4zIiwidXBkYXRlZEluVmVyIjoiMzguMjEuMyIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsidHlwZS9taW5vciJdfQ==-->

Co-authored-by: lumiere-bot[bot] <98047013+lumiere-bot[bot]@users.noreply.github.com>
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.

4 participants