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.

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

Remove forbidden @author tag #37005

Open
wants to merge 11 commits into
base: 2.4-develop
Choose a base branch
from
Open

Remove forbidden @author tag #37005

wants to merge 11 commits into from

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 #37255: 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
Open
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 Apr 25, 2023
@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 re-request them if they don't show in a reasonable amount of time.

@engcom-Lima
Copy link
Contributor

engcom-Lima commented Apr 25, 2023 •
edited
Loading

✔️ QA Passed

Preconditions:

  • Install fresh Magento 2.4-develop and PHP 8.1

Manual testing scenario:

  • Verified @author tag got removed from newsletter module.

After: ✔️
Screenshot 2023-04-25 at 12 13 04 PM

Screenshot 2023-04-25 at 12 13 24 PM

Since builds are failed. Hence, moving this PR to Extended Testing

@engcom-Echo
Copy link
Contributor

@magento run all tests

@engcom-Charlie engcom-Charlie self-assigned this Sep 10, 2024
@engcom-Charlie
Copy link
Contributor

@magento run all tests

@engcom-Charlie
Copy link
Contributor

@magento run all tests

@engcom-Charlie
Copy link
Contributor

@magento run Static Tests

@engcom-Charlie
Copy link
Contributor

@magento run all tests

@engcom-Charlie
Copy link
Contributor

@magento run Functional Tests B2B, Functional Tests CE

@engcom-Charlie
Copy link
Contributor

@magento run Static Tests

1 similar comment
@engcom-Charlie
Copy link
Contributor

@magento run Static Tests

@engcom-Charlie
Copy link
Contributor

@magento run all tests

1 similar comment
@engcom-Charlie
Copy link
Contributor

@magento run all tests

@engcom-Charlie
Copy link
Contributor

@magento run Database Compare, Static Tests, Unit Tests

@engcom-Charlie
Copy link
Contributor

@magento run Database Compare, Unit Tests

@engcom-Charlie
Copy link
Contributor

@magento run all tests

@engcom-Charlie
Copy link
Contributor

Hi @fredden,

Can you please have a look into Static test failure.

Thank you!

@fredden
Copy link
Member Author

fredden commented Oct 1, 2024

@engcom-Charlie see 22f6c28. This should fix the ignore rule that you added in 3cffac6. Note that the error comes from PHP Mess Detector, not PHP_CodeSniffer.

@engcom-Charlie
Copy link
Contributor

@magento run all tests

@engcom-Charlie
Copy link
Contributor

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

@engcom-Charlie
Copy link
Contributor

The Functional EE tests in recent 2 builds are not consistent. Those are not part of PR or not failing because of PR changes. Seems to be flaky. Hence moving it to Merge in Progress.

Run 1:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/37005/97bdd7a121028468ccba3fe3c8ce27f3/Functional/allure-report-ee/index.html#categories

image

Run 2:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/37005/a0f9d276c0a6dd2a311e7e7bd441f6c6/Functional/allure-report-ee/index.html#categories

image

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-Charlie engcom-Charlie

@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: ready for testing
Projects
Pull Requests Dashboard
Status: Merge in Progress
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Issue] Remove forbidden @author tag
7 participants
@fredden @leonhelmus @ihor-sviziev @engcom-Lima @engcom-Echo @engcom-Charlie @m2-github-services