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

Resolve Warnings in Documentation Generation on PHP 8.2 while Maintaining PHP 8.0 Compatibility #22

Closed
shcherbanich opened this issue Oct 3, 2023 · 2 comments · Fixed by #41
Assignees
Labels

Comments

@shcherbanich
Copy link
Contributor

shcherbanich commented Oct 3, 2023

When running the command bumbleDocGen generate under PHP 8.2, a few warnings are encountered. The objective is to resolve these warnings ensuring smooth functionality while keeping the codebase compatible with PHP 8.0. Here's how to proceed:

  1. Identify Warnings:

    • Pinpoint the warnings encountered during the documentation generation process under PHP 8.2.
  2. Resolve Warnings:

    • Address and fix the identified warnings ensuring that the functionality remains intact.
  3. Maintain Compatibility:

    • Ensure that the changes made are backward compatible with PHP 8.0.
  4. Testing:

    • Use PHPUnit to validate that the warnings have been resolved and the functionality is unaffected.
    • Run composer run-script test locally to confirm that all tests pass.
  5. Create Pull Request:

    • Once the warnings are resolved and tested, create a pull request to the 1.x.x branch with your fixes.
    • GitHub will automatically run your tests again when you create the pull request.
  6. Need Help?

    • If you encounter any issues or require clarification on the process, feel free to comment on the issue, and a maintainer will assist you.

By addressing these warnings, we aim to ensure that BumbleDocGen operates flawlessly under PHP 8.2 while maintaining compatibility with PHP 8.0.

@shcherbanich shcherbanich added enhancement New feature or request good first issue Good for newcomers hacktoberfest bug Something isn't working and removed enhancement New feature or request labels Oct 3, 2023
@seanmcn seanmcn changed the title Fix errors when starting documentation generation under PHP 8.2 Resolve Warnings in Documentation Generation on PHP 8.1 while Maintaining PHP 8.0 Compatibility Oct 4, 2023
@shcherbanich shcherbanich changed the title Resolve Warnings in Documentation Generation on PHP 8.1 while Maintaining PHP 8.0 Compatibility Resolve Warnings in Documentation Generation on PHP 8.2 while Maintaining PHP 8.0 Compatibility Oct 4, 2023
@misantron
Copy link
Contributor

Your code now is not compatible with PHP 8.2 because of using ocramius/proxy-manager which PHP version requirement is php: ~8.0.0. It's impossible to install dependencies via running composer install under PHP 8.2.

@shcherbanich
Copy link
Contributor Author

shcherbanich commented Oct 5, 2023

UPD: ocramius/proxy-manager removed: https://github.com/bumble-tech/bumble-doc-gen/tree/1.x.x

It turned out that we do not depend much on this library.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants