[ASPNETCORE] Add support for central package version management #20192

Urganot · 2024-11-26T22:30:09Z

This pr adds support for using centralized package version management.

For this two options were added:

useCentralizedPackageVersionManagement Type: Boolean, Default: false
centralizedPackageVersionManagementOptOut Type Boolean, Default: false

Setting useCentralizedPackageVersionManagement true will add the ManagePackageVersionsCentrally property to the csproj file, set the value to true and remove explicit versions from packages
Setting useCentralizedPackageVersionManagement true will add the ManagePackageVersionsCentrally property to the csproj file and set the value to false

Template files for both kinds of projects were updated accordingly.
A sample with useCentralizedPackageVersionManagement: true was added

Technical Committee mentions:
@mandrean @shibayan @Blackclaws @lucamazzanti @iBicha

PR checklist

Read the contribution guidelines.
Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
Run the following to build the project and update samples:
```
./mvnw clean package || exit
./bin/generate-samples.sh ./bin/configs/*.yaml || exit
./bin/utils/export_docs_generators.sh || exit
```
(For Windows users, please run the script in Git BASH)
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

wing328 · 2024-11-28T14:19:07Z

https://github.com/OpenAPITools/openapi-generator/actions/runs/12040139303/job/33660370623?pr=20192

i don't think .net 9.0 is supported by the aspnetcore generator at the moment, and we welcome PRs with such enhancement.

Urganot · 2024-11-28T16:21:57Z

https://github.com/OpenAPITools/openapi-generator/actions/runs/12040139303/job/33660370623?pr=20192

i don't think .net 9.0 is supported by the aspnetcore generator at the moment, and we welcome PRs with such enhancement.

That wasn't on purpose. It was left from my changes regarding .net9. I corrected it

Btw. can I set a PR to squash merge?

Urganot · 2024-11-28T16:44:06Z

I noticed that the regenerated sample files are now using windows style line breaks and directory divider even in strings.

Do you know of a way to fix this?

wing328 · 2024-11-30T02:44:27Z

pushed a commit with updated samples and docs. let's see how that goes

wing328 · 2024-11-30T02:45:18Z

can you please review the build errors (e.g. https://github.com/OpenAPITools/openapi-generator/actions/runs/12092892132/job/33723209893?pr=20192) when you've time?

Urganot · 2024-11-30T12:53:27Z

Done

Urganot · 2024-11-30T13:59:02Z

The up to date check fails because of the window/linux thing

wing328 · 2024-11-30T14:48:02Z

do you have Windows Subsystem for Linux (WSL) installed (assuming you're using Windows)? you can try to run the script to update the samples under WSL.

Urganot · 2024-12-01T20:00:37Z

Using WSL worked

wing328 · 2024-12-02T07:41:33Z

modules/openapi-generator/src/main/resources/aspnetcore/3.0/ModelsProject.csproj.mustache

+{{#centralizedPackageVersionManagementOptOut}}
+    <ManagePackageVersionsCentrally>false</ManagePackageVersionsCentrally>
+{{/centralizedPackageVersionManagementOptOut}}
+


can we simplify this to just one option (e.g. managePackageVersionsCentrally, which is a string, not boolean)?

{{#ManagePackageVersionsCentrally}} <ManagePackageVersionsCentrally>{{{.}}}</ManagePackageVersionsCentrally> {{/ManagePackageVersionsCentrally}}

if it's set to false, add another additional properties skipVersion for below.

If I understand you correctly that would mean when setting it to false it has a different behaviour than dont setting it at all?
Personally I dont like this. As a user I would expect that if I dont set it at all it would do the same as false. If you want to have only one option though, we could use a enum with "true", "opt-out", "default". Not setting it would use the default option

As a user I would expect that if I dont set it at all it would do the same as false

we can default the option to false

We could, but not having the property in the .csproj file and setting the property to false are very different things

OK

we could use a enum with "true", "opt-out", "default". Not setting it would use the default option

what about having 3 values in a single option instead as you suggested earlier?

I've fixed the option and filed #20401

Here is what the error message looks like:

[main] WARN o.o.c.languages.AspNetServerCodegen - ASP.NET core version is 8.0 so changing to use frameworkReference instead of packageReference Exception in thread "main" java.lang.RuntimeException: Invalid value `something` for the option `centralizedPackageVersionManagement`. Please refer to the documentation for more information. at org.openapitools.codegen.languages.AspNetServerCodegen.processOpts(AspNetServerCodegen.java:497) at org.openapitools.codegen.DefaultGenerator.configureGeneratorProperties(DefaultGenerator.java:261) at org.openapitools.codegen.DefaultGenerator.generate(DefaultGenerator.java:1288) at org.openapitools.codegen.cmd.Generate.execute(Generate.java:535) at org.openapitools.codegen.cmd.OpenApiGeneratorCommand.run(OpenApiGeneratorCommand.java:32) at org.openapitools.codegen.OpenAPIGenerator.main(OpenAPIGenerator.java:66)

Can you please take a look when you've time?

I think you will need to make some more updates.

Can you pull the latest and submit new PRs targeting `Urganot-central-package-version-management-option instead?

Sure.
I dont understand what you did here. why is this enum so dofferent from all other enums?

no idea. i simply copied the implementation (option of enum values) from other generators.

how can this be? doesnt this imply that something is wrong? either with how enums are handled generally or in aspnetcore specifically?

as I said I didn't debug your code, I simply copied a working implementation from another generator that's proven to be working (with correctly validation)

in other words, we can go with a working implementation instead of reinventing the wheel.

* [C] Deprecate *_create() to avoid *_free() confusion The behaviour of *_free() doesn't match *_create(), so the user should avoid using them together. But they still need *_free() to clean up library-allocated objects, so add a _library_owned flag to each struct as an attempt to tell them apart. This isn't perfect though, because the user may neglect to zero the field, but they would still see a warning once in a while so it serves its purpose. To prevent the new deprecation warnings (intended for the user) from showing up during the library build itself, define a new family of *_create_internal() functions, and turn *_create() into simple wrappers. * Update samples * add eafer to c technical committee --------- Co-authored-by: William Cheng <[email protected]>

Manage colon converting to underscore on sanitize

* Adds @nullable annotation to Spring Boot generator * issue-14427: [REQ][spring] Null-Safety annotations * issue-17382: [REQ] spring generator add Nullable annotations Motivations: * Have Spring Boot generator client properly annotated for nullability to be able to check code using them with tools like NullAway * As it is related to Spring then the `org.springframework.lang.Nullable` annotation was chosen to avoid discussion which `@Nullable` one is true one * `@NonNull` wasn't used as I didn't see much benefit of it. Anyhow, an empty constructor and/or setters allow to put a `null` value there Modifications: * Adds nullableAnnotation template to handle nullability annotation on vars * Adjust pojo templates to use the nullability template * Adapts tests Modifications: * Runs export_docs_generator.sh script to update samples * samples update * excludes Spring @nullable from java-camel * ones with defaults shouldn't be annotated as @nullable * updates samples * adds AllArgConstructor generation tests * adds container tests

…ement-option

#20403) * Fixed default value for usePackageVersions * Regenerated docs

wing328 reviewed Dec 2, 2024

View reviewed changes

wing328 mentioned this pull request Jan 5, 2025

[ASPNETCORE] Add support for central package version management #20401

Draft

5 tasks

eafer and others added 4 commits January 6, 2025 10:53

OpenAPITools#20390 : (OpenAPITools#20391)

4b5dfc4

Manage colon converting to underscore on sanitize

Merge branch 'OpenAPITools:master' into central-package-version-manag…

8d4c1f3

…ement-option

Urganot changed the base branch from master to Urganot-central-package-version-management-option January 6, 2025 12:33

Urganot closed this Jan 6, 2025

Urganot deleted the central-package-version-management-option branch January 6, 2025 12:39

Urganot mentioned this pull request Jan 6, 2025

[ASPNETCORE] Add support for central package version management #20192 #20403

Merged

wing328 pushed a commit that referenced this pull request Jan 6, 2025

[ASPNETCORE] Add support for central package version management #20192 (

e7ac57d

#20403) * Fixed default value for usePackageVersions * Regenerated docs

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ASPNETCORE] Add support for central package version management #20192

[ASPNETCORE] Add support for central package version management #20192

Urganot commented Nov 26, 2024

wing328 commented Nov 28, 2024

Urganot commented Nov 28, 2024 •

edited

Loading

Urganot commented Nov 28, 2024 •

edited

Loading

wing328 commented Nov 30, 2024

wing328 commented Nov 30, 2024

Urganot commented Nov 30, 2024

Urganot commented Nov 30, 2024

wing328 commented Nov 30, 2024

Urganot commented Dec 1, 2024

wing328 Dec 2, 2024

Urganot Dec 2, 2024 •

edited

Loading

wing328 Dec 2, 2024

Urganot Dec 2, 2024

wing328 Dec 2, 2024

wing328 Jan 5, 2025 •

edited

Loading

Urganot Jan 5, 2025

wing328 Jan 5, 2025

Urganot Jan 5, 2025

wing328 Jan 5, 2025

[ASPNETCORE] Add support for central package version management #20192

[ASPNETCORE] Add support for central package version management #20192

Conversation

Urganot commented Nov 26, 2024

PR checklist

wing328 commented Nov 28, 2024

Urganot commented Nov 28, 2024 • edited Loading

Urganot commented Nov 28, 2024 • edited Loading

wing328 commented Nov 30, 2024

wing328 commented Nov 30, 2024

Urganot commented Nov 30, 2024

Urganot commented Nov 30, 2024

wing328 commented Nov 30, 2024

Urganot commented Dec 1, 2024

Choose a reason for hiding this comment

Urganot Dec 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wing328 Jan 5, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Urganot commented Nov 28, 2024 •

edited

Loading

Urganot commented Nov 28, 2024 •

edited

Loading

Urganot Dec 2, 2024 •

edited

Loading

wing328 Jan 5, 2025 •

edited

Loading