magento2
magento2 copied to clipboard
magento
Remove forbidden `@author` tag from framework (part 1)
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
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#37268: Remove forbidden
@authortag from framework (part 1)
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 Compare -
Functional Tests CE -
Functional Tests EE -
Functional Tests B2B -
Integration Tests -
Magento Health Index -
Sample Data Tests CE -
Sample Data Tests EE -
Sample Data Tests B2B -
Static Tests -
Unit Tests -
WebAPI Tests -
Semantic 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.
![m2-assistant[bot] avatar](https://avatars.githubusercontent.com/in/27048?v=4 "Published by a pub.dev verified publisher"){kind=small}
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-automated-testing[bot] avatar](https://avatars.githubusercontent.com/in/43625?v=4 "Published by a pub.dev verified publisher"){kind=small}
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.
Adding the same priority as https://github.com/magento/magento2/pull/36976#event-8742638190
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.
:heavy_check_mark: QA Passed
Preconditions:
- Install fresh Magento
2.4-developandPHP 8.1
Manual testing scenario:
- Verified @author tag got removed from
framework.
Before: :heavy_multiplication_x:
After: :heavy_check_mark:
No additional manual test cases is required as part of regression as this PR is related to the removal of @author tag from framework module.
Builds are failed. Hence, moving this PR to Extended Testing.
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.
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.
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.
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.
Functional Tests CE failure are different on last two run on same commit.
Run1
Run2
Hence moving it to merge in progress
By adding latest code in this PR branch, we are getting SVC failures. In order to move this PR further, we need green build hence moving it back to Extended Testing.
@engcom-Charlie There is nothing in this pull request which should trigger any errors/warnings for the semantic version checker. When I click on the links here on GitHub, the results are all green / pass, but the result has come back as a failure. I'll update this branch and run the tests again. If the error persists, I recommend you get this investigated internally as there seems to be something wrong with the pipeline - unrelated to the code changes in this pull request.