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

docs(php): Add missing configuration property composerPackageName #15846

Merged
merged 1 commit into from
Jul 12, 2023
Merged

docs(php): Add missing configuration property composerPackageName #15846

merged 1 commit into from
Jul 12, 2023

Conversation

phramz
Copy link
Contributor

@phramz phramz commented Jun 14, 2023

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 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    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*.
    For Windows users, please run the script in Git BASH.
  • In case you are adding a new generator, run the following additional script :
    ./bin/utils/ensure-up-to-date
    
    Commit all changed files.
  • File the PR against the correct branch: master (6.3.0) (minor release - breaking changes with fallbacks), 7.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.

@phramz
Copy link
Contributor Author

phramz commented Jun 14, 2023

@phramz
Copy link
Contributor Author

phramz commented Jun 20, 2023

looks like it's set via the packageName:

https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPhpCodegen.java#L827-L847

Thank for your reply @wing328!

The methods' (getComposerPackageName()) return-value will only be available in the template if all conditions including the regex are met:
https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPhpCodegen.java#L213-L215

Due to Github user names might contain upper case letters and the name regex won't match them, it's very likely that you will end up without a name attribute in the composer.json.

You can workaround this issue by explicitly setting the composerPackageName as additional property. Therefor I think it's worth being documented.

If it's a good thing to use Github user/repo as is in the first place is another topic ;)

@wing328 wing328 merged commit 7cbdc86 into OpenAPITools:master Jul 12, 2023
@phramz phramz deleted the patch-1 branch July 12, 2023 21:14
@wing328 wing328 added this to the 7.0.0 milestone Aug 16, 2023
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.

2 participants