Remove forbidden `@author` tag #37003

fredden · 2023-03-07T13:46:16Z

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:

resolves [Issue] Remove forbidden @author tag #37253: Remove forbidden @author tag

m2-assistant · 2023-03-07T13:46:19Z

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:

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
ℹ️ 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.

magento-automated-testing · 2023-03-07T14:25:48Z

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

Looks good to me

leonhelmus · 2023-03-20T10:37:15Z

@magento create issue

ihor-sviziev · 2023-03-22T13:26:59Z

Adding the same priority as #36976 (comment)

…integration

engcom-Lima · 2023-04-18T08:04:20Z

@magento run all tests

magento-automated-testing · 2023-04-18T08:04:25Z

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 · 2023-04-18T10:37:36Z

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

magento-automated-testing · 2023-04-18T10:37:42Z

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 · 2023-04-18T14:24:44Z

@magento run Static Tests , Functional Tests EE

engcom-Lima · 2023-04-18T14:25:56Z

@magento run Functional Tests EE

…integration

engcom-Lima · 2023-04-18T14:27:23Z

@magento run all tests

magento-automated-testing · 2023-04-18T14:33:42Z

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 · 2023-04-18T14:34:05Z

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 · 2023-04-18T14:35:31Z

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 · 2023-04-18T14:36:08Z

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 · 2023-04-19T07:34:00Z

✔️ QA Passed

Preconditions:

Install fresh Magento 2.4-develop and PHP 8.1

Manual testing scenario:

Verified @author tag got removed from email-fedex-groupedproduct-integration module.

After: ✔️

No addiitional manual test cases is required for the regression as this PR related to the removal of the @author tag from the email-fedex-groupedproduct-integration module.

Multiple builds are failing hence, moving this PR to Extended Testing

…ail-fedex-groupedproduct-integration

magento-automated-testing · 2023-09-11T10:26:02Z

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.

…integration

engcom-Charlie · 2024-06-19T09:29:47Z

@magento run all tests

engcom-Charlie · 2024-06-20T07:59:10Z

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

…integration

engcom-Charlie · 2024-06-25T09:07:03Z

@magento run all tests

…integration

engcom-Charlie · 2024-06-28T06:16:47Z

@magento run all tests

engcom-Charlie · 2024-06-28T09:34:29Z

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

engcom-Charlie · 2024-07-01T07:10:17Z

The Functional CE failures are not related to the PR changes as failing tests are known issues, below is list of open JIRAs for the same.

Run 1:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/37003/cd8400f547e9addde26a27128dc19059/Functional/allure-report-ce/index.html#categories

Run 2:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/37003/21db55cf401ab445382013250ae54d6f/Functional/allure-report-ce/index.html#categories

Known issues:
ACQE-6695 - TierPricingWhenPriceScopeIsWebsiteWorkingProperlyWithMultipleCurrenciesConfiguredTest
ACQE-6774 - StorefrontCashOnDeliveryPaymentForSpecificCountryTest

engcom-Charlie · 2024-07-01T07:17:09Z

The Functional EE failures are not related to the PR changes as failing tests are known issues, below is list of open JIRAs for the same.

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

Run 2:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/37003/6aaafc25d2cac9bffc92644cb0ac9efe/Functional/allure-report-ee/index.html#categories/f9b62a55a184699bcb07a760e8ac3662/d3c2e79e520d5d9b/

Known issues:
ACQE-6695 - TierPricingWhenPriceScopeIsWebsiteWorkingProperlyWithMultipleCurrenciesConfiguredTest
ACQE-6331 - StorefrontCreateOrderAllQuantityGroupedProductOptionDefaultStockTest
ACQE-6774 - StorefrontCashOnDeliveryPaymentForSpecificCountryTest

engcom-Charlie · 2024-07-01T07:22:10Z

@magento run Functional Tests B2B

engcom-Charlie · 2024-07-01T09:47:20Z

The Functional B2B failures are not related to the PR changes as failing tests are known issues, below is list of open JIRAs for the same. Hence moving this PR to Merge in Progress

Run 1:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/37003/2d7be885d14a6a14fbb68ff82e714c33/Functional/allure-report-b2b/index.html#categories

Run 2
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/37003/fd7c9b90fdea5625d91c8d08b749a84e/Functional/allure-report-b2b/index.html#categories/8f0831c1d06562890f5ec21062dae309/da277d4c25e77809/

Known issues:
ACQE-6695 - TierPricingWhenPriceScopeIsWebsiteWorkingProperlyWithMultipleCurrenciesConfiguredTest
ACQE-6774 - StorefrontCashOnDeliveryPaymentForSpecificCountryTest

Remove forbidden @author tag

99536b1

m2-github-services added Partner: Fisheye partners-contribution Pull Request is created by Magento Partner labels Mar 7, 2023

leonhelmus approved these changes Mar 20, 2023

View reviewed changes

m2-community-project bot assigned leonhelmus Mar 20, 2023

m2-community-project bot added the Progress: ready for testing label Mar 20, 2023

m2-assistant bot mentioned this pull request Mar 20, 2023

[Issue] Remove forbidden @author tag #37253

Closed

5 tasks

ihor-sviziev added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Mar 22, 2023

Merge branch '2.4-develop' into no-author/email-fedex-groupedproduct-…

f0a5e02

…integration

engcom-Lima self-assigned this Apr 18, 2023

m2-community-project bot added Progress: testing in progress and removed Progress: ready for testing labels Apr 18, 2023

This comment was marked as duplicate.

Sign in to view

Merge branch '2.4-develop' into no-author/email-fedex-groupedproduct-…

ad3ec7c

…integration

m2-community-project bot added Progress: extended testing and removed Progress: testing in progress labels Apr 19, 2023

Merge remote-tracking branch 'upstream/2.4-develop' into no-author/em…

9bff7fb

…ail-fedex-groupedproduct-integration

engcom-Charlie self-assigned this Jun 19, 2024

m2-community-project bot added Progress: ready for testing and removed Progress: extended testing labels Jun 19, 2024

Merge branch '2.4-develop' into no-author/email-fedex-groupedproduct-…

cfebd6a

…integration

m2-community-project bot added Progress: extended testing and removed Progress: ready for testing labels Jun 24, 2024

Indrani Sonawane and others added 2 commits June 25, 2024 14:32

Fixed static test failures

9faf353

Merge branch '2.4-develop' into no-author/email-fedex-groupedproduct-…

377805f

…integration

Merge branch '2.4-develop' into no-author/email-fedex-groupedproduct-…

51a33b4

…integration

m2-community-project bot added Progress: accept and removed Progress: extended testing labels Jul 1, 2024

magento-devops-reposync-svc merged commit e9830bf into magento:2.4-develop Jul 14, 2024
9 of 12 checks passed

fredden deleted the no-author/email-fedex-groupedproduct-integration branch July 14, 2024 09:01

Remove forbidden @author tag #37003

Remove forbidden @author tag #37003

Conversation

fredden commented Mar 7, 2023 • edited by m2-assistant bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Manual testing scenarios

Contribution checklist

Resolved issues:

Uh oh!

m2-assistant bot commented Mar 7, 2023

Uh oh!

magento-automated-testing bot commented Mar 7, 2023

Uh oh!

leonhelmus left a comment

Choose a reason for hiding this comment

Uh oh!

leonhelmus commented Mar 20, 2023

Uh oh!

ihor-sviziev commented Mar 22, 2023

Uh oh!

engcom-Lima commented Apr 18, 2023

Uh oh!

magento-automated-testing bot commented Apr 18, 2023

Uh oh!

engcom-Lima commented Apr 18, 2023

Uh oh!

magento-automated-testing bot commented Apr 18, 2023

Uh oh!

This comment was marked as duplicate.

engcom-Lima commented Apr 18, 2023

Uh oh!

engcom-Lima commented Apr 18, 2023

Uh oh!

engcom-Lima commented Apr 18, 2023

Uh oh!

magento-automated-testing bot commented Apr 18, 2023

Uh oh!

magento-automated-testing bot commented Apr 18, 2023

Uh oh!

magento-automated-testing bot commented Apr 18, 2023

Uh oh!

magento-automated-testing bot commented Apr 18, 2023

Uh oh!

engcom-Lima commented Apr 19, 2023

Uh oh!

magento-automated-testing bot commented Sep 11, 2023

Uh oh!

engcom-Charlie commented Jun 19, 2024

Uh oh!

engcom-Charlie commented Jun 20, 2024

Uh oh!

engcom-Charlie commented Jun 25, 2024

Uh oh!

engcom-Charlie commented Jun 28, 2024

Uh oh!

engcom-Charlie commented Jun 28, 2024

Uh oh!

engcom-Charlie commented Jul 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

engcom-Charlie commented Jul 1, 2024

Uh oh!

engcom-Charlie commented Jul 1, 2024

Uh oh!

engcom-Charlie commented Jul 1, 2024

Uh oh!

Uh oh!

Uh oh!

Remove forbidden `@author` tag #37003

Remove forbidden `@author` tag #37003

fredden commented Mar 7, 2023 •

edited by m2-assistant bot

Loading

engcom-Charlie commented Jul 1, 2024 •

edited

Loading