Skip to content

Remove forbidden @author tag #37010

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 10 commits into from
May 10, 2025
Merged

Remove forbidden @author tag #37010

merged 10 commits into from
May 10, 2025

Conversation

fredden
Copy link
Member

@fredden fredden commented Mar 7, 2023 •
edited by m2-assistant bot
Loading

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 magento/magento-coding-standard#382 and magento/magento-coding-standard#167

Manual testing scenarios

There are not code changes in this pull request. This pull request only removes forbidden comments.

Contribution checklist

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
  • All automated tests passed successfully (all builds are green)

Resolved issues:

  1. resolves [Issue] Remove forbidden @author tag #37260: Remove forbidden @author tag

@m2-assistant
Copy link

m2-assistant bot commented Mar 7, 2023

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

❗ 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:
  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

You can find more information about the builds here
ℹ️ 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-github-services m2-github-services added Partner: Fisheye partners-contribution Pull Request is created by Magento Partner labels Mar 7, 2023
@magento-automated-testing
Copy link

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.

leonhelmus
leonhelmus approved these changes Mar 20, 2023
View reviewed changes
Copy link

@leonhelmus leonhelmus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@leonhelmus
Copy link

@magento create issue

@m2-assistant m2-assistant bot mentioned this pull request Mar 20, 2023
Closed
5 tasks
@ihor-sviziev ihor-sviziev added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Mar 22, 2023
@ihor-sviziev
Copy link
Contributor

Adding the same priority as #36976 (comment)

@engcom-Lima engcom-Lima self-assigned this May 15, 2023
@engcom-Lima
Copy link
Contributor

✔️ QA Passed

Preconditions:

  • Install fresh Magento 2.4-develop and PHP 8.1

Manual testing scenario:

  • Verified @author tag got removed from reports-sales module.

Before: ✖️
Screenshot 2023-05-15 at 2 37 03 PM

Screenshot 2023-05-15 at 2 37 19 PM

After: ✔️
Screenshot 2023-05-15 at 2 41 57 PM
image

No additional manual test cases is required as part of regression as this PR is related to the removal of @author tag from reports-sales module.
Builds are failed. Hence, moving this PR to Extended Testing.

@engcom-Lima
Copy link
Contributor

@magento run all tests

@magento-automated-testing
Copy link

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.

@engcom-Echo
Copy link
Contributor

@magento run all tests

@magento-automated-testing Magento Automated Testing
Copy link

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.

@engcom-Echo
Copy link
Contributor

@magento run all tests

@engcom-Echo engcom-Echo self-assigned this Jun 19, 2024
@engcom-Echo
Copy link
Contributor

@magento run all tests

@engcom-Echo
Copy link
Contributor

@magento run all tests

@engcom-Echo
Copy link
Contributor

@magento run Static Tests

@engcom-Echo
Copy link
Contributor

@magento run all tests

@engcom-Echo
Copy link
Contributor

@magento run Integration Tests,Functional Tests EE,Functional Tests CE,Functional Tests B2B

@engcom-Echo
Copy link
Contributor

Functional Tests CE,Functional Tests EE,Functional Tests B2B failure are different on last two run on same commit. Also build failure contain some known failures.
List of known failures.
ACQE-6774
ACQE-6695
ACQE-6331
ACQE-6786
ACQE-6469

Functional Test B2B
Run1
37010-b2b

Run2
Screenshot 2024-07-10 at 3 32 50 PM

Functional Test CE
Run1
37010-ce

Run2
37010-ce2

Functional Test EE
Run1
37010-ee

Run2
Screenshot 2024-07-10 at 3 32 59 PM

Hence moving it to merge in progress

@engcom-Hotel
Copy link
Contributor

@magento run all tests

@engcom-Hotel
Copy link
Contributor

@magento run Functional Tests B2B, Functional Tests CE, Functional Tests EE

@engcom-Hotel
Copy link
Contributor

@magento run all tests

@engcom-Hotel
Copy link
Contributor

engcom-Hotel commented May 2, 2025 •
edited
Loading

The failed functional tests are known issues, the related internal JIRA for the same is as follows:

image

image

Thanks

@magento-devops-reposync-svc magento-devops-reposync-svc merged commit 84311ef into magento:2.4-develop May 10, 2025
10 of 12 checks passed
@ct-prd-projects-boards-automation ct-prd-projects-boards-automation bot moved this from Merge in Progress to Recently Merged in Pull Requests Dashboard May 10, 2025
@fredden fredden deleted the no-author/reports-sales branch May 10, 2025 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leonhelmus leonhelmus leonhelmus approved these changes

Assignees

@leonhelmus leonhelmus

@engcom-Echo engcom-Echo

@engcom-Lima engcom-Lima

Labels
Partner: Fisheye partners-contribution Pull Request is created by Magento Partner Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: accept
Projects
Pull Requests Dashboard
Status: Recently Merged
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Issue] Remove forbidden @author tag
9 participants
@fredden @leonhelmus @ihor-sviziev @engcom-Lima @engcom-Echo @engcom-Hotel @magento-devops-reposync-svc @m2-github-services @glo24157