pulumi / pulumi/pulumi-java

[api/suggestion] rename `App.java` in templates/examples

Open
#409 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

api/suggestion area/tooling kind/enhancement
Dominant language
Java
Stars
85
Forks
26
Avg merge
11h 49m
Merged PRs (30d)
22

Description

Hello!

  • Vote on this issue by adding a 👍 reaction
  • If you want to implement this feature, comment to let us know (we'll work with you on design, scheduling, etc.)

Issue details

I'm working on a demo and I want to embed pulumi-java into an existing spring app. The default name in examples App seems to be confusing and it might be good to have a more sensible default.

We can have users put their pulumi programs in a different directory as such and that might be better:
com.example.springboot.Application
com.example.pulumi.App

I still think it would be good to rename App.java since it's very common.
2022-04-16-213915_1283x931_scrot
A standard that doesn't clash with existing classes would reduce the likelihood of renames and help lead to common pulumi-java idioms. i.e. PulumiStack.

Affected area/feature

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating App.java in the templates and examples, then review how the example package and class names are presented alongside the existing Spring application naming. Choose a non-conflicting default such as the proposed PulumiStack, update the affected examples consistently, and verify that the generated templates use the new class name.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
developer-experience
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.