search

shopware / docs

Shopware 6 developer docs
https://developer.shopware.com/
51 stars 259 forks source link

markdown-lint ignores source files #1563

Open jrson83 opened 6 days ago

jrson83 commented 6 days ago

I noticed when running make fix on the local repository, markdown-lint is running on all source files. It fixes a lot of errors but also throws a lot of errors it is not able to fix. I checked the workflow and found de8e515.

It seams that the fix command wasn't used for a while. Is it intentional that markdown-lint doesn't actually run on the source files in the GitHub workflow?

Isengo1989 commented 7 hours ago

Those mentioned -> https://github.com/shopware/docs/commit/de8e51583559da68d38decc9c14f8a79456108a6 are excluded because they are pulled externally and would throw an error on every new import.

They come from here for example

https://github.com/shopware/shopware/tree/trunk/adr

jrson83 commented 2 hours ago

@Isengo1989 can you please try to reproduce, maybe I did not explain well:

git clone https://github.com/shopware/docs.git && cd docs && make fix

Will run avtodev/markdown-lint:v1.5 actually with --config /docs/markdown-style-config.yml on the docs folder. It fixes many issues, but throws many errors.

The GitHub workflow does not run on any of the markdown files in docs/, thats why it ends with success.

Image

Cloning into 'docs'...
remote: Enumerating objects: 30449, done.
remote: Counting objects: 100% (285/285), done.
remote: Compressing objects: 100% (180/180), done.
remote: Total 30449 (delta 156), reused 179 (delta 97), pack-reused 30164 (from 1)
Receiving objects: 100% (30449/30449), 29.75 MiB | 11.08 MiB/s, done.
Resolving deltas: 100% (20130/20130), done.
docker run --rm -u "1000:1000" -v "/home/dev/shopware-docs/1/docs:/docs" -e INPUT_FIX=true -e INPUT_IGNORE='/docs/resources/references/* /docs/adr/*' avtodev/markdown-lint:v1.5 \
    --config /docs/markdown-style-config.yml /docs
/docs/assets/adr/catalog-import/examples.md:2 MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "::: info"]
/docs/concepts/extensions/index.md:14 MD045/no-alt-text Images should have alternate text (alt text)
/docs/concepts/extensions/index.md:20 MD045/no-alt-text Images should have alternate text (alt text)
/docs/concepts/framework/http_cache.md:25 MD045/no-alt-text Images should have alternate text (alt text)
/docs/concepts/framework/rules.md:73 MD045/no-alt-text Images should have alternate text (alt text)
/docs/guides/hosting/infrastructure/filesystem.md:119 MD003/heading-style/header-style Heading style [Expected: atx; Actual: setext]
/docs/guides/hosting/infrastructure/filesystem.md:119 MD025/single-title/single-h1 Multiple top level headings in the same document [Context: "If you want to regulate the up..."]
/docs/guides/hosting/infrastructure/redis.md:19:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1]
/docs/guides/hosting/infrastructure/redis.md:20:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 3; Style: 1/1/1]
/docs/guides/hosting/infrastructure/reverse-http-cache.md:27 MD045/no-alt-text Images should have alternate text (alt text)
/docs/guides/hosting/infrastructure/reverse-http-cache.md:126 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/guides/hosting/infrastructure/scheduled-task.md:60 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/guides/hosting/infrastructure/scheduled-task.md:87 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/guides/hosting/installation-updates/deployments/deployment-helper.md:160:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1]
/docs/guides/hosting/performance/k6.md:30:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1]
/docs/guides/hosting/performance/k6.md:36:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 3; Style: 1/1/1]
/docs/guides/installation/devenv.md:206:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/guides/installation/devenv.md:207:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/guides/installation/requirements.md:79:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/guides/installation/requirements.md:80:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/guides/installation/requirements.md:81:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/guides/installation/requirements.md:82:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/guides/installation/requirements.md:83:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/guides/integrations-api/general-concepts/partial-data-loading.md:12 MD001/heading-increment/header-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
/docs/guides/plugins/apps/shipping-methods.md:126:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
/docs/guides/plugins/apps/shipping-methods.md:127:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
/docs/guides/plugins/apps/shipping-methods.md:128:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
/docs/guides/plugins/apps/shipping-methods.md:129:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
/docs/guides/plugins/apps/shipping-methods.md:205 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/guides/plugins/plugins/administration/add-rule-assignment-configuration.md:18 MD045/no-alt-text Images should have alternate text (alt text)
/docs/guides/plugins/plugins/content/media/remote-thumbnail-generation.md:32:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1]
/docs/guides/plugins/plugins/framework/event/finding-events.md:228 MD045/no-alt-text Images should have alternate text (alt text)
/docs/guides/plugins/plugins/framework/flow/action-transactions.md:80:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1]
/docs/guides/plugins/plugins/framework/flow/action-transactions.md:81:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 3; Style: 1/1/1]
/docs/guides/plugins/plugins/framework/system-check/index.md:32:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/guides/plugins/plugins/framework/system-check/index.md:33:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/guides/plugins/plugins/framework/system-check/index.md:34:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/guides/plugins/plugins/framework/system-check/index.md:78:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/guides/plugins/plugins/framework/system-check/index.md:79:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/guides/plugins/plugins/framework/system-check/index.md:80:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/guides/plugins/plugins/redis.md:43:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1]
/docs/guides/plugins/plugins/redis.md:72:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 3; Style: 1/1/1]
/docs/guides/plugins/plugins/storefront/add-custom-captcha.md:30:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: plus]
/docs/index.md:17 MD045/no-alt-text Images should have alternate text (alt text)
/docs/products/digital-sales-rooms/best-practices/app-deployment/cloudflare.md:20:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/products/digital-sales-rooms/best-practices/app-deployment/cloudflare.md:22 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/products/digital-sales-rooms/best-practices/app-deployment/cloudflare.md:27:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/products/digital-sales-rooms/best-practices/app-deployment/cloudflare.md:33:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/products/digital-sales-rooms/best-practices/app-deployment/cloudflare.md:35:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/products/digital-sales-rooms/best-practices/app-deployment/cloudflare.md:41:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/products/digital-sales-rooms/best-practices/app-deployment/cloudflare.md:51:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/products/digital-sales-rooms/best-practices/app-deployment/cloudflare.md:52:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/products/digital-sales-rooms/best-practices/app-deployment/cloudflare.md:53:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/products/digital-sales-rooms/best-practices/app-deployment/cloudflare.md:54:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/products/digital-sales-rooms/best-practices/app-deployment/cloudflare.md:60:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/products/digital-sales-rooms/best-practices/app-deployment/cloudflare.md:117:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/products/digital-sales-rooms/best-practices/app-deployment/cloudflare.md:118:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/products/digital-sales-rooms/configuration/domain-config.md:25 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/products/digital-sales-rooms/installation/app-installation.md:18 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/products/digital-sales-rooms/installation/app-installation.md:24 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/products/digital-sales-rooms/installation/app-installation.md:32 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/products/digital-sales-rooms/installation/app-installation.md:54 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/products/digital-sales-rooms/installation/app-installation.md:60 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/products/digital-sales-rooms/installation/app-installation.md:66 MD025/single-title/single-h1 Multiple top level headings in the same document [Context: "# Build frontend App"]
/docs/products/digital-sales-rooms/installation/app-installation.md:72 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/products/digital-sales-rooms/installation/app-installation.md:78 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/products/extensions/advanced-search/How-to-extend-the-search-and-suggest-template.md:23 MD025/single-title/single-h1 Multiple top level headings in the same document [Context: "# How to extend the suggest te..."]
/docs/products/extensions/b2b-components/employee-management/guides/creating-own-permissions-via-app.md:10:152 MD042/no-empty-links No empty links [Context: "[/store-api/permission]()"]
/docs/products/extensions/b2b-components/index.md:37:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1]
/docs/products/extensions/b2b-components/index.md:45 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/products/extensions/b2b-components/order-approval/concepts/01-entities-and-workflow.md:41:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/products/extensions/b2b-components/order-approval/concepts/01-entities-and-workflow.md:42:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/products/extensions/b2b-components/order-approval/concepts/01-entities-and-workflow.md:43:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/products/extensions/b2b-components/order-approval/concepts/01-entities-and-workflow.md:47:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/products/extensions/b2b-components/order-approval/concepts/01-entities-and-workflow.md:48:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/products/extensions/b2b-components/order-approval/concepts/01-entities-and-workflow.md:49:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/products/extensions/b2b-components/order-approval/guides/02-order-approval-permissions.md:12 MD001/heading-increment/header-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
/docs/products/extensions/b2b-components/shopping-lists/guides/api-and-pricing.md:14 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/products/extensions/b2b-components/shopping-lists/guides/api-and-pricing.md:22 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/products/extensions/b2b-components/shopping-lists/guides/api-and-pricing.md:30 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/products/extensions/b2b-components/shopping-lists/guides/api-and-pricing.md:36 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/products/extensions/b2b-components/shopping-lists/guides/api-and-pricing.md:42 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/products/extensions/b2b-components/shopping-lists/guides/api-and-pricing.md:52 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/products/extensions/b2b-components/shopping-lists/guides/api-and-pricing.md:58 MD025/single-title/single-h1 Multiple top level headings in the same document [Context: "# Admin API"]
/docs/products/extensions/b2b-components/shopping-lists/guides/api-and-pricing.md:62 MD025/single-title/single-h1 Multiple top level headings in the same document [Context: "# Shopping lists price"]
/docs/products/paas/index.md:37:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1]
/docs/products/paas/index.md:43:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 3; Style: 1/1/1]
/docs/products/paas/index.md:49:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 4; Style: 1/1/1]
/docs/products/paas/index.md:55:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 5; Style: 1/1/1]
/docs/products/paas/index.md:61:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 6; Style: 1/1/1]
/docs/products/paas/index.md:67:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 7; Style: 1/1/1]
/docs/products/paas/index.md:75:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 8; Style: 1/1/1]
/docs/products/sales-agent/installation.md:17:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1]
/docs/products/sales-agent/installation.md:21 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/products/sales-agent/installation.md:27:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 3; Style: 1/1/1]
/docs/products/sales-agent/installation.md:37:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 4; Style: 1/1/1]
/docs/products/sales-agent/installation.md:43:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 5; Style: 1/1/1]
/docs/products/sales-agent/installation.md:81:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1]
/docs/products/sales-agent/installation.md:82:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 3; Style: 1/1/1]
/docs/resources/guidelines/code/core/6.5-new-php-language-features.md:2 MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "::: info"]
/docs/resources/guidelines/code/core/adr.md:2 MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "::: info"]
/docs/resources/guidelines/code/core/decorator-pattern.md:2 MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "::: info"]
/docs/resources/guidelines/code/core/domain-exceptions.md:2 MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "::: info"]
/docs/resources/guidelines/code/core/extendability.md:2 MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "::: info"]
/docs/resources/guidelines/code/core/extendability.md:50:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/resources/guidelines/code/core/extendability.md:51:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/resources/guidelines/code/core/extendability.md:52:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/resources/guidelines/code/core/extendability.md:53:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/resources/guidelines/code/core/extendability.md:54:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/resources/guidelines/code/core/extendability.md:55:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/resources/guidelines/code/core/extendability.md:56:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/resources/guidelines/code/core/extendability.md:57:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/resources/guidelines/code/core/extendability.md:58:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/resources/guidelines/code/core/extendability.md:59:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
/docs/resources/guidelines/code/core/final-and-internal.md:2 MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "::: info"]
/docs/resources/guidelines/code/core/internal.md:2 MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "::: info"]
/docs/resources/guidelines/code/core/unit-tests.md:2 MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "::: info"]
/docs/resources/guidelines/code/core/unit-tests.md:60:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1]
/docs/resources/guidelines/code/core/unit-tests.md:119:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 2; Style: 1/1/1]
/docs/resources/guidelines/code/core/unit-tests.md:120:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 3; Style: 1/1/1]
/docs/resources/guidelines/code/core/writing-code-for-static-analysis.md:2 MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "::: info"]
/docs/resources/guidelines/documentation-guidelines/07-embedding-external-repositories.md:193 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/resources/guidelines/documentation-guidelines/07-embedding-external-repositories.md:202 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/resources/guidelines/documentation-guidelines/07-embedding-external-repositories.md:211 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/resources/guidelines/documentation-guidelines/07-embedding-external-repositories.md:219 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
/docs/resources/guidelines/testing/store/quality-guidelines-plugins/index.md:363:1 MD005/list-indent Inconsistent indentation for list items at the same level [Expected: 0; Actual: 1]
/docs/snippets/guide/app_database_setup.md:1 MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "The App Bundle ships with a ba..."]
make: *** [Makefile:20: fix] Error 1