magento2
magento2 copied to clipboard
Remove forbidden `@author` tag from `Magento_Customer` (part 2)
Description
According to https://devdocs.magento.com/guides/v2.4/coding-standards/docblock-standard-general.html#documentation-space, the @author tag is not permitted in Magento. This pull request removes this tag from some modules. Given there are so many instances of this tag, I've opened a small pull request to get the process started. I expect that the linter will force me to fix several other coding standards violations on the way, so having a smaller pull request means that task is easier to manage. I plan to open more pull requests to tackle the other instances of this tag.
See also https://github.com/magento/magento-coding-standard/pull/382 and https://github.com/magento/magento-coding-standard/issues/167
See also https://github.com/magento/magento2/pull/36304, https://github.com/magento/magento2/pull/36976, https://github.com/magento/magento2/pull/36977, https://github.com/magento/magento2/pull/36978, https://github.com/magento/magento2/pull/36979, https://github.com/magento/magento2/pull/36980, https://github.com/magento/magento2/pull/36981, https://github.com/magento/magento2/pull/36987, https://github.com/magento/magento2/pull/36988, https://github.com/magento/magento2/pull/36989, https://github.com/magento/magento2/pull/36990, https://github.com/magento/magento2/pull/36991, https://github.com/magento/magento2/pull/36993, https://github.com/magento/magento2/pull/36999
Manual testing scenarios
There are not code changes in this pull request. This pull request only removes forbidden comments.
Contribution checklist
- [x] Pull request has a meaningful description of its purpose
- [x] All commits are accompanied by meaningful commit messages
- [x] All new or changed code is covered with unit/integration tests (if applicable)
- [x] README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
- [x] All automated tests passed successfully (all builds are green)
Resolved issues:
- [x] resolves magento/magento2#37250: Remove forbidden
@authortag fromMagento_Customer(part 2)
Hi @fredden. Thank you for your contribution! Here are some useful tips on how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:
@magento give me test instance- deploy test instance based on PR changes@magento give me 2.4-develop instance- deploy vanilla Magento instance
:exclamation: Automated tests can be triggered manually with an appropriate comment:
@magento run all tests- run or re-run all required tests against the PR changes@magento run <test-build(s)>- run or re-run specific test build(s) For example:@magento run Unit Tests
<test-build(s)> is a comma-separated list of build names.
Allowed build names are:
Database CompareFunctional Tests CEFunctional Tests EEFunctional Tests B2BIntegration TestsMagento Health IndexSample Data Tests CESample Data Tests EESample Data Tests B2BStatic TestsUnit TestsWebAPI TestsSemantic Version Checker
You can find more information about the builds here :information_source: Run only required test builds during development. Run all test builds before sending your pull request for review.
For more details, review the Code Contributions documentation. Join Magento Community Engineering Slack and ask your questions in #github channel.
The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.
The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.
The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.
@magento create issue
Adding the same priority as https://github.com/magento/magento2/pull/36976#event-8742638190
@magento run Functional Tests B2B,Functional Tests CE, Functional Tests EE,Static Tests
The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.
:heavy_check_mark: QA Passed
Preconditions:
- Install fresh Magento
2.4-developandPHP 8.1
Manual testing scenario:
- Verified @author tag got removed from
Magento_Customer.
Before: :heavy_multiplication_x:
After: :heavy_check_mark:
No addiitional manual test cases is required for the regression as this PR related to the removal of the @author tag from the Magento_Customer module.
Multiple builds are failing hence, moving this PR to Extended Testing
@magento run all tests
The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.
The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.
@magento run all tests
@magento run all tests
Functional Tests B2B,Functional Tests CE,Functional Tests EE failure contains known and flaky failures not related to PR changes.
Functional Tests B2B
Run1
Run2
Functional Tests CE
Run1
Run2
Functional Tests EE
Run1
Run2
Hence moving it to merge in progress
@magento run Functional Tests EE,Functional Tests CE,Functional Tests B2B