Run lychee to find dead links

shyim commented 1 year ago

See example action: https://github.com/opensearch-project/opensearch-php/blob/main/.github/workflows/links.yml

Example output:

``` [./resources/references/adr/2021-05-28-introduce-eslint-on-vue-admin.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/resources/references/.vscode/settings.json | Failed: Cannot find file ✗ [ERR] file:///Users/shyim/Developer/docs/resources/references/src/Administration/Resources/app/administration/twigVuePlugin/lib/processors/twig-vue-processor.js | Failed: Cannot find file [./guides/hosting/infrastructure/scheduled-task.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/guides/hosting/message-queue.md | Failed: Cannot find file [./resources/guidelines/code/core/writing-code-for-static-analysis.md]: ✗ [404] https://github.com/shopware/platform/blob/trunk/code/core/writing-code-for-static-analysis.md | Failed: Network error: Not Found [./products/extensions/b2b-suite/guides/administration/README.md]: ✗ [404] https://developer.shopware.com/docs/guides/plugins/plugins/administration | Failed: Network error: Not Found [./resources/guidelines/testing/e2e-best-practises.md]: ✗ [404] https://scd.shopware.com/en/ | Failed: Network error: Not Found [./guides/plugins/apps/app-sdks/symfony-bundle/index.md]: ✗ [404] https://developer.shopware.com/docs/guides/plugins/apps | Failed: Network error: Not Found [./guides/plugins/plugins/framework/message-queue/add-message-handler.md]: ✗ [ERR] http://upstart.ubuntu.com/getting-started.html | Failed: Network error: dns error: no record found for Query { name: Name("upstart.ubuntu.com.shopware.local."), query_type: AAAA, query_class: IN } [./resources/references/adr/2022-06-17-integrate-app-into-flow-event.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/resources/adr/admin/flow-builder/2022-07-21-adding-the-StorableFlow-to-implement-DelayAction-in-Flow-Builder.md | Failed: Cannot find file [./resources/guidelines/code/core/6.5-new-php-language-features.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/resources/guidelines/adr/feature-adoption/2023-02-06-php-enums.md | Failed: Cannot find file ✗ [404] https://github.com/shopware/platform/blob/trunk/code/core/6.5-new-php-language-features.md | Failed: Network error: Not Found ✗ [ERR] file:///Users/shyim/Developer/docs/resources/guidelines/adr/feature-adoption/2023-02-06-symfony-dependency-management.md | Failed: Cannot find file [./resources/guidelines/code/pageloader.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/resources/references/adr/extension/2020-11-25-decoration-pattern.md | Failed: Cannot find file [./guides/plugins/plugins/administration/add-rule-assignment-configuration.md]: ✗ [404] https://github.com/shopware/platform/blob/trunk/src/Administration/Resources/app/administration/src/core/factory/component.factory.ts | Failed: Network error: Not Found [./guides/installation/devenv.md]: ✗ [ERR] http://localhost:8025/ | Failed: Network error: tcp connect error: Connection refused (os error 61) ✗ [ERR] http://localhost:9080/ | Failed: Network error: tcp connect error: Connection refused (os error 61) ↻ [ERR] http://localhost:8025/ | Cached: Error (cached) ↻ [ERR] http://localhost:9080/ | Cached: Error (cached) ✗ [ERR] http://localhost:8000/ | Failed: Network error: tcp connect error: Connection refused (os error 61) ↻ [ERR] http://localhost:8000/ | Cached: Error (cached) [./products/extensions/b2b-components/employee-management/guides/creating-own-permissions-via-app.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/products/resources/references/app-reference/script-reference/script-hooks-reference.md | Failed: Cannot find file [./products/paas/repository.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/guides/installation/flex.md | Failed: Cannot find file [./products/plugins/commercial/README.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/guides/plugins/plugins/plugin-base-guide | Failed: Cannot find file [./resources/references/adr/2020-08-12-implement-app-system-inside-platform.md]: ✗ [404] https://docs.shopware.com/en/shopware-platform-dev-en/app-system-guide/app-examples-and-tutorials/create-own-theme?category=shopware-platform-dev-en/app-system-guide/app-examples-and-tutorials | Failed: Network error: Not Found [./resources/guidelines/code/core/extendability.md]: ✗ [404] https://developer.shopware.com/docs/guides/plugins/apps/app-scripts | Failed: Network error: Not Found ✗ [404] https://github.com/shopware/platform/blob/trunk/code/core/extendability.md | Failed: Network error: Not Found [./resources/references/core-reference/rules-reference.md]: ✗ [404] https://github.com/shopware/platform/blob/trunk/src/Core/Checkout/Cart/Rule/LineItemsInCartRule.php | Failed: Network error: Not Found [./resources/guidelines/testing/store/quality-guidelines-apps/README.md]: ✗ [404] https://developer.shopware.com/docs/guides/plugins/apps/storefront | Failed: Network error: Not Found ✗ [404] https://developer.shopware.com/docs/guides/plugins/apps/administration | Failed: Network error: Not Found ✗ [404] https://rules.sonarsource.com/javascript/RSPEC-2611 | Failed: Network error: Not Found [./resources/references/app-reference/payment-reference.md]: ✗ [ERR] https://payment.app/ | Failed: Too many redirects: error following redirect for url (https://twitter.com/dot_app_tld): too many redirects [./resources/guidelines/code/core/unit-tests.md]: ✗ [404] https://github.com/shopware/platform/blob/trunk/code/core/unit-tests.md | Failed: Network error: Not Found ✗ [404] https://github.com/shopware/platform/blob/trunk/tests/unit/php/Core/Checkout/Cart/Price/CashRoundingTest.php | Failed: Network error: Not Found ✗ [404] https://github.com/shopware/platform/blob/trunk/tests/unit/php/Core/Framework/DataAbstractionLayer/Search/CriteriaTest.php | Failed: Network error: Not Found ✗ [404] https://github.com/shopware/platform/blob/trunk/tests/unit/php/Core/Content/Flow/Dispatching/Action/AddCustomerTagActionTest.php | Failed: Network error: Not Found [./products/extensions/b2b-suite/guides/core/entity-acl.md]: ✗ [ERR] https://docs.enterprise.shopware.com/b2b-suite/technical/store-front-authentication/ | Failed: Network error: dns error: no record found for Query { name: Name("docs.enterprise.shopware.com.shopware.local."), query_type: AAAA, query_class: IN } ✗ [ERR] https://docs.enterprise.shopware.com/b2b-suite/technical/acl-routes/ | Failed: Network error: dns error: no record found for Query { name: Name("docs.enterprise.shopware.com.shopware.local."), query_type: AAAA, query_class: IN } [./resources/references/adr/2021-01-21-deprecation-strategy.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/resources/references/adr/DetailedRules | Failed: Cannot find file [./products/community-edition.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/concepts/commerce/core/shopping-experiences-cms.md | Failed: Cannot find file [./resources/references/administration-reference/mixins.md]: ✗ [ERR] file:///Users/shyim/Developer/guides/plugins/plugins/administration/add-mixins.md | Failed: Cannot find file ✗ [ERR] file:///Users/shyim/Developer/guides/plugins/plugins/administration/using-mixins.md | Failed: Cannot find file [./resources/guidelines/code/core/benchmarks.md]: ✗ [404] https://github.com/shopware/platform/blob/trunk/code/core/benchmarks.md | Failed: Network error: Not Found [./resources/guidelines/code/core/adr.md]: ✗ [404] https://github.com/shopware/platform/blob/trunk/code/core/adr.md | Failed: Network error: Not Found [./resources/guidelines/code/core/internal.md]: ✗ [404] https://github.com/shopware/platform/blob/trunk/code/core/internal.md | Failed: Network error: Not Found [./resources/references/adr/2022-07-19-blog-concept.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/resources/references/app/2021-09-14-technical-concept-custom-entities.md | Failed: Cannot find file [./products/extensions/b2b-suite/guides/installation/README.md]: ⧖ [TIMEOUT] http://10.100.200.46/ | Timeout [./guides/plugins/plugins/administration/using-mixins.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/resources/references/core-reference/administration-reference/mixins.md | Failed: Cannot find file [./SUMMARY.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/guides/installation/legacy/docker.md | Failed: Cannot find file ✗ [ERR] file:///Users/shyim/Developer/docs/guides/installation/legacy/from-scratch.md | Failed: Cannot find file ✗ [ERR] file:///Users/shyim/Developer/docs/guides/installation/legacy/valet.md | Failed: Cannot find file ✗ [ERR] file:///Users/shyim/Developer/docs/guides/installation/legacy/README.md | Failed: Cannot find file ✗ [ERR] file:///Users/shyim/Developer/docs/guides/installation/legacy/mamp.md | Failed: Cannot find file [./resources/references/adr/2022-10-20-deprecation-handling-during-phpunit-test-execution.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/resources/references/workflow/2022-02-28-consistent-deprecation-notices-in-core.md | Failed: Cannot find file [./guides/plugins/plugins/storefront/add-data-to-storefront-page.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/guides/plugins/plugins/framework/store-api/add-store-api-route | Failed: Cannot find file [./guides/plugins/plugins/framework/data-handling/add-data-indexer.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/resources/references/adr/dal/2021-05-14-when-to-use-plain-sql-or-dal.md | Failed: Cannot find file [./resources/guidelines/code/core/final-and-internal.md]: ✗ [404] https://github.com/shopware/platform/blob/trunk/code/core/final-and-internal.md | Failed: Network error: Not Found [./guides/plugins/apps/README.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/guides/plugins/overview | Failed: Cannot find file [./guides/plugins/plugins/checkout/cart/tax-provider.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/concepts/framework/data-abstraction-layer | Failed: Cannot find file [./resources/references/administration-reference/directives.md]: ✗ [ERR] file:///Users/shyim/Developer/guides/plugins/plugins/administration/adding-directives.md | Failed: Cannot find file [./guides/hosting/installation-updates/cluster-setup.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/guides/hosting/installation-updates/composer.md | Failed: Cannot find file [./resources/guidelines/code/core/domain-exceptions.md]: ✗ [404] https://github.com/shopware/platform/blob/trunk/code/core/domain-exceptions.md | Failed: Network error: Not Found [./guides/plugins/plugins/api/customer-specific-pricing.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/guides/plugins/plugins/plugin-base-guide | Failed: Cannot find file [./guides/plugins/plugins/administration/using-utils.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/resources/references/core-reference/administration-reference/utils.md | Failed: Cannot find file [./guides/plugins/plugins/README.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/guides/plugins/overview | Failed: Cannot find file [./concepts/commerce/catalog/categories.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/concepts/commerce/core/shopping-experiences-cms.md | Failed: Cannot find file [./resources/guidelines/testing/store/quality-guidelines-plugins/README.md]: ✗ [404] https://rules.sonarsource.com/javascript/RSPEC-2611 | Failed: Network error: Not Found [./guides/hosting/performance/performance-tweaks.md]: ✗ [404] https://developer.shopware.com/docs/v/6.4/resources/references/adr/performance/2022-03-25-prevent-mail-updates | Failed: Network error: Not Found [./guides/plugins/apps/starter/starter-admin-extension.md]: ↻ [404] https://developer.shopware.com/docs/guides/plugins/apps/app-scripts | Cached: Error (cached) ✗ [ERR] http://127.0.0.1:8080/ | Failed: Network error: tcp connect error: Connection refused (os error 61) ↻ [ERR] http://127.0.0.1:8080/ | Cached: Error (cached) [./resources/guidelines/code/backward-compatibility.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/resources/references/adr/workflow/2020-08-03-implement-New-Changelog.md | Failed: Cannot find file ✗ [ERR] file:///Users/shyim/Developer/docs/resources/references/adr/workflow/2020-08-10-feature-flag-system.md | Failed: Cannot find file [./guides/plugins/plugins/administration/add-custom-component.md]: ✗ [404] https://alligator.io/js/object-property-shorthand-es6/ | Failed: Network error: Not Found [./guides/plugins/plugins/checkout/cart/add-cart-items.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/resources/references/adr/checkout/2021-03-24-nested-line-items.md | Failed: Cannot find file [./guides/plugins/plugins/api/multi-inventory.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/guides/plugins/plugins/plugin-base-guide | Failed: Cannot find file [./resources/references/security.md]: ✗ [ERR] file:///Users/shyim/Developer/guides/hosting/configurations/framework/samesite-protection.md | Failed: Cannot find file ✗ [ERR] file:///Users/shyim/Developer/guides/hosting/infrastructure/rate-limiter.md | Failed: Cannot find file ✗ [ERR] file:///Users/shyim/Developer/guides/hosting/configurations/shopware/html-sanitizer.md | Failed: Cannot find file ✗ [ERR] file:///Users/shyim/Developer/guides/hosting/installation-updates/cluster-setup.md | Failed: Cannot find file [./guides/plugins/plugins/testing/php-unit.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/guides/plugins/guides/installation/template.md | Failed: Cannot find file [./resources/guidelines/code/core/decorator-pattern.md]: ✗ [404] https://github.com/shopware/platform/71ef1dffc97a131069cd4649f71ba35d04771e24/trunk/adr/2020-11-25-decoration-pattern.md | Failed: Network error: Not Found ✗ [404] https://github.com/shopware/platform/blob/trunk/code/core/decorator-pattern.md | Failed: Network error: Not Found [./guides/hosting/installation-updates/deployments/deployment-with-deployer.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/guides/hosting/installation/template.md | Failed: Cannot find file [./guides/plugins/plugins/content/stock/implementing-your-own-stock-storage.md]: ✗ [ERR] file:///Users/shyim/Developer/docs/guides/installation/configuration | Failed: Cannot find file ```

bojanrajh commented 1 year ago

Vitepress already has the ignoreDeadlinks option which we will activate in the future release.

Isengo1989 commented 1 year ago

@bojanrajh can we close that issue then?

I see that both repos have that flag active already, but before the creation of that ticket :thinking:

https://github.com/shopware/developer-portal/blame/e30499c63a242613b9ce081893194a5ea1aa2075/.vitepress/config.ts#L315

https://github.com/shopware/developer-documentation-vitepress/blame/5fe25cb69900ebb016d4a5ee21904ea6974fe748/src/shopware/config/baseConfig.js#L134

bojanrajh commented 1 year ago

The current flag is ignoreDeadlinks: true, we want to set that to false. I'd keep the issue open, but you can close it if it's bothering you. :)

Isengo1989 commented 1 year ago

@bojanrajh Fine be me

Vitepress already has the ignoreDeadlinks option which we will activate in the future release.

Activating it sounding like it will be true not false :smile: We leave it open then :+1:

bojanrajh commented 11 months ago

Closing as we have set the ignoreDeadlinks option and validate-external-links.yml workflow.

shopware / docs

Run lychee to find dead links #1110