fix: updated example with version number (#48)

* fix: updated example with version number

* chore: added changeset lint

Author: OndrejTuma

.eslintignore

@@ -2,3 +2,5 @@
 /node_modules
 /reports
 **/dist/**
+!.changeset
+.changeset/README.md

.lintstagedrc.js

@@ -1,5 +1,5 @@
 module.exports = {
-  '*.{js,jsx,ts,tsx}': ['davinci-syntax lint code', 'prettier --write'],
+  '{**/*.{js,jsx,ts,tsx},.changeset/*.md}': ['davinci-syntax lint code', 'prettier --write'],
   '{action.yml,README.md}': paths =>
     paths.length > 0
       ? ['yarn documentation:generate', `git add */README.md`]

package.json

@@ -19,7 +19,7 @@
     "@changesets/cli": "^2.22.0",
     "@toptal/browserslist-config": "^1.2.0",
     "@toptal/davinci-qa": "^12.1.0",
-    "@toptal/davinci-syntax": "^16.1.3",
+    "@toptal/davinci-syntax": "^16.2.0",
     "@types/js-yaml": "^4.0.5",
     "@types/marked": "^4.0.3",
     "@types/node": "^17.0.34",

report-affected-packages/README.md

@@ -1,6 +1,6 @@
 ## Report affected packages
 
-Generate a diagram of affected monorepo packages as a job summary. Works with worksflows triggered by pull\_request event.
+Generate a diagram of affected monorepo packages as a job summary. Works with workflows triggered by pull\_request event.
 
 ### Description
 
@@ -22,5 +22,5 @@ Not specified
 
 ```yaml
   - name: Generate the affected packages report
-    uses: toptal/davinci-github-actions/report-affected-packages
+    uses: toptal/davinci-github-actions/report-affected-packages@v4.2.1
 ```

report-affected-packages/action.yml

@@ -1,5 +1,5 @@
 name: 'Report affected packages'
-description: 'Generate a diagram of affected monorepo packages as a job summary. Works with worksflows triggered by pull_request event.'
+description: 'Generate a diagram of affected monorepo packages as a job summary. Works with workflows triggered by pull_request event.'
 
 runs:
   using: 'composite'

yarn.lock

@@ -1817,10 +1817,10 @@
   dependencies:
     "@sinonjs/commons" "^1.7.0"
 
-"@stylelint/postcss-css-in-js@^0.37.2":
-  version "0.37.3"
-  resolved "https://registry.yarnpkg.com/@stylelint/postcss-css-in-js/-/postcss-css-in-js-0.37.3.tgz#d149a385e07ae365b0107314c084cb6c11adbf49"
-  integrity sha512-scLk3cSH1H9KggSniseb2KNAU5D9FWc3H7BxCSAIdtU9OWIyw0zkEZ9qEKHryRM+SExYXRKNb7tOOVNAsQ3iwg==
+"@stylelint/postcss-css-in-js@^0.38.0":
+  version "0.38.0"
+  resolved "https://registry.yarnpkg.com/@stylelint/postcss-css-in-js/-/postcss-css-in-js-0.38.0.tgz#eabb061df932744db766f11a153ae1c465b6263c"
+  integrity sha512-XOz5CAe49kS95p5yRd+DAIWDojTjfmyAQ4bbDlXMdbZTQ5t0ThjSLvWI6JI2uiS7MFurVBkZ6zUqcimzcLTBoQ==
   dependencies:
     "@babel/core" "^7.17.9"
 
@@ -1932,15 +1932,15 @@
     matchmedia-polyfill "^0.3.2"
     semver "^7.3.2"
 
-"@toptal/davinci-syntax@^16.1.3":
-  version "16.1.3"
-  resolved "https://registry.yarnpkg.com/@toptal/davinci-syntax/-/davinci-syntax-16.1.3.tgz#a257aa41b40a5d3408fb4b875c3820de0f7f940f"
-  integrity sha512-srr/Qb7MuPJHlyxnXpDo1jimImn6C1mk7kbv+BNzdDXtR7dZQtAoScZyKIsNMSEHIJcUDBAp/cicczjLPCWvww==
+"@toptal/davinci-syntax@^16.2.0":
+  version "16.2.0"
+  resolved "https://registry.yarnpkg.com/@toptal/davinci-syntax/-/davinci-syntax-16.2.0.tgz#50ad8b7c79384d981b3ea52404ba07844e139119"
+  integrity sha512-I0dio118qtgYuMNfT78S0v43J6sFsAhN5ZRSGxfBUkhC/kdk4rcuCJQzBR+rA96QAdkLqR3LS5l6Pz+xWnNXCg==
   dependencies:
-    "@stylelint/postcss-css-in-js" "^0.37.2"
+    "@stylelint/postcss-css-in-js" "^0.38.0"
     "@toptal/davinci-cli-shared" "1.7.0"
     "@toptal/davinci-dir-lint" "^0.2.1"
-    "@toptal/eslint-plugin-davinci" "5.3.1"
+    "@toptal/eslint-plugin-davinci" "5.4.0"
     "@typescript-eslint/eslint-plugin" "^5.19.0"
     "@typescript-eslint/parser" "^5.30.7"
     eslint "^8.19.0"
@@ -1968,17 +1968,19 @@
     stylelint-config-styled-components "^0.1.1"
     stylelint-processor-styled-components "^1.10.0"
 
-"@toptal/eslint-plugin-davinci@5.3.1":
-  version "5.3.1"
-  resolved "https://registry.yarnpkg.com/@toptal/eslint-plugin-davinci/-/eslint-plugin-davinci-5.3.1.tgz#90f268bc2603461c40b118ae125c71fdf05e56e1"
-  integrity sha512-LnxsCp26sJ8yB7RwY2zxCVsX7jTEeVFkryI78DeT1DXrQOMlPGLmamKfMDuxk4306kPZ3kiMYUiPiImIYVmC7Q==
+"@toptal/eslint-plugin-davinci@5.4.0":
+  version "5.4.0"
+  resolved "https://registry.yarnpkg.com/@toptal/eslint-plugin-davinci/-/eslint-plugin-davinci-5.4.0.tgz#3a77c3ce8daf0ffde85f8b26e36c95438043ca57"
+  integrity sha512-oCSopFB7HKsSSTfOuNrOwhsWXoSHjm2AM3tsq2ht9Ead/6JKCzwZuFvlyvWf9EYHwAtSusEoiBgDQCFDSWToBw==
   dependencies:
     eslint "^8.19.0"
+    eslint-plugin-markdownlint "^0.4.0"
     eslint-plugin-sort-keys-fix "^1.1.2"
     find-up "^5.0.0"
     find-yarn-workspace-root "^2.0.0"
     ignore "^5.2.0"
     lodash.kebabcase "^4.1.1"
+    markdownlint "^0.26.2"
     micromatch "^4.0.4"
     require-json5 "^1.1.0"
     requireindex "^1.2.0"
@@ -3721,6 +3723,11 @@ enquirer@^2.3.0, enquirer@^2.3.6:
   dependencies:
     ansi-colors "^4.1.1"
 
+entities@~3.0.1:
+  version "3.0.1"
+  resolved "https://registry.yarnpkg.com/entities/-/entities-3.0.1.tgz#2b887ca62585e96db3903482d336c1006c3001d4"
+  integrity sha512-WiyBqoomrwMdFG1e0kqvASYfnlb0lp8M5o5Fw2OFq1hNZxxcNk8Ik0Xm7LxzBhuidnZB/UtBqVCgUz3kBOP51Q==
+
 error-ex@^1.3.1:
   version "1.3.2"
   resolved "https://registry.yarnpkg.com/error-ex/-/error-ex-1.3.2.tgz#b4ac40648107fdcdcfae242f428bea8a14d4f1bf"
@@ -3881,6 +3888,13 @@ eslint-plugin-jest@^26.4.5:
   dependencies:
     "@typescript-eslint/utils" "^5.10.0"
 
+eslint-plugin-markdownlint@^0.4.0:
+  version "0.4.0"
+  resolved "https://registry.yarnpkg.com/eslint-plugin-markdownlint/-/eslint-plugin-markdownlint-0.4.0.tgz#ee70192efb05d451d5287c1b0454a280e5568f30"
+  integrity sha512-k5ZvMP11HJd3ggpmgfc+LSesx/QK75wsD7wQJjj2lLf0eJCMGQl8Osq0T4EmjJzBX0T0D3IlmArkhpj2wLg7Lg==
+  dependencies:
+    markdownlint "0.26.0"
+
 eslint-plugin-no-inline-styles@^1.0.5:
   version "1.0.5"
   resolved "https://registry.yarnpkg.com/eslint-plugin-no-inline-styles/-/eslint-plugin-no-inline-styles-1.0.5.tgz#c37a7e7a53b46312852d2c44c02cac0df2e700c3"
@@ -6066,6 +6080,13 @@ lines-and-columns@^1.1.6:
   resolved "https://registry.yarnpkg.com/lines-and-columns/-/lines-and-columns-1.2.4.tgz#eca284f75d2965079309dc0ad9255abb2ebc1632"
   integrity sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==
 
+linkify-it@^4.0.1:
+  version "4.0.1"
+  resolved "https://registry.yarnpkg.com/linkify-it/-/linkify-it-4.0.1.tgz#01f1d5e508190d06669982ba31a7d9f56a5751ec"
+  integrity sha512-C7bfi1UZmoj8+PQx22XyeXCuBlokoyWQL5pWSP+EI6nzRylyThouddufc2c1NDIcP9k5agmN9fLpA7VNJfIiqw==
+  dependencies:
+    uc.micro "^1.0.1"
+
 lint-staged@^13.0.2:
   version "13.0.3"
   resolved "https://registry.yarnpkg.com/lint-staged/-/lint-staged-13.0.3.tgz#d7cdf03a3830b327a2b63c6aec953d71d9dc48c6"
@@ -6319,11 +6340,36 @@ map-obj@^4.0.0:
   resolved "https://registry.yarnpkg.com/map-obj/-/map-obj-4.3.0.tgz#9304f906e93faae70880da102a9f1df0ea8bb05a"
   integrity sha512-hdN1wVrZbb29eBGiGjJbeP8JbKjq1urkHJ/LIP/NY48MZ1QVXUsQBV1G1zvYFHn1XE06cwjBsOI2K3Ulnj1YXQ==
 
+[email protected]:
+  version "13.0.1"
+  resolved "https://registry.yarnpkg.com/markdown-it/-/markdown-it-13.0.1.tgz#c6ecc431cacf1a5da531423fc6a42807814af430"
+  integrity sha512-lTlxriVoy2criHP0JKRhO2VDG9c2ypWCsT237eDiLqi09rmbKoUetyGHq2uOIRoRS//kfoJckS0eUzzkDR+k2Q==
+  dependencies:
+    argparse "^2.0.1"
+    entities "~3.0.1"
+    linkify-it "^4.0.1"
+    mdurl "^1.0.1"
+    uc.micro "^1.0.5"
+
 markdown-table@^3.0.0:
   version "3.0.2"
   resolved "https://registry.yarnpkg.com/markdown-table/-/markdown-table-3.0.2.tgz#9b59eb2c1b22fe71954a65ff512887065a7bb57c"
   integrity sha512-y8j3a5/DkJCmS5x4dMCQL+OR0+2EAq3DOtio1COSHsmW2BGXnNCK3v12hJt1LrUz5iZH5g0LmuYOjDdI+czghA==
 
+[email protected]:
+  version "0.26.0"
+  resolved "https://registry.yarnpkg.com/markdownlint/-/markdownlint-0.26.0.tgz#1e800ecc709ed4061c18ab03f1cba23f58511421"
+  integrity sha512-I7nfRVwKVs/AJi4BlBkUCNj/S4HJjZSSM1wbzdy7vZerFkSGpbs7wX9Rk8rvopvZjTTKFPQWItqdbl2Hh6YXQQ==
+  dependencies:
+    markdown-it "13.0.1"
+
+markdownlint@^0.26.2:
+  version "0.26.2"
+  resolved "https://registry.yarnpkg.com/markdownlint/-/markdownlint-0.26.2.tgz#11d3d03e7f0dd3c2e239753ee8fd064a861d9237"
+  integrity sha512-2Am42YX2Ex5SQhRq35HxYWDfz1NLEOZWWN25nqd2h3AHRKsGRE+Qg1gt1++exW792eXTrR4jCNHfShfWk9Nz8w==
+  dependencies:
+    markdown-it "13.0.1"
+
 matchmedia-polyfill@^0.3.2:
   version "0.3.2"
   resolved "https://registry.yarnpkg.com/matchmedia-polyfill/-/matchmedia-polyfill-0.3.2.tgz#4666e252aead72e8dd232a9fbde5d93fa50497d3"
@@ -6395,6 +6441,11 @@ mdast-util-to-string@^3.0.0, mdast-util-to-string@^3.1.0:
   resolved "https://registry.yarnpkg.com/mdast-util-to-string/-/mdast-util-to-string-3.1.0.tgz#56c506d065fbf769515235e577b5a261552d56e9"
   integrity sha512-n4Vypz/DZgwo0iMHLQL49dJzlp7YtAJP+N07MZHpjPf/5XJuHUWstviF4Mn2jEiR/GNmtnRRqnwsXExk3igfFA==
 
+mdurl@^1.0.1:
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/mdurl/-/mdurl-1.0.1.tgz#fe85b2ec75a59037f2adfec100fd6c601761152e"
+  integrity sha512-/sKlQJCBYVY9Ers9hqzKou4H6V5UWc/M59TH2dvkt+84itfnq7uFOMLpOiOS4ujvHP4etln18fmIxA5R5fll0g==
+
 meow@^6.0.0:
   version "6.1.1"
   resolved "https://registry.yarnpkg.com/meow/-/meow-6.1.1.tgz#1ad64c4b76b2a24dfb2f635fddcadf320d251467"
@@ -8561,6 +8612,11 @@ typescript@^4.6.4:
   resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.6.4.tgz#caa78bbc3a59e6a5c510d35703f6a09877ce45e9"
   integrity sha512-9ia/jWHIEbo49HfjrLGfKbZSuWo9iTMwXO+Ca3pRsSpbsMbc7/IU8NKdCZVRRBafVPGnoJeFL76ZOAA84I9fEg==
 
+uc.micro@^1.0.1, uc.micro@^1.0.5:
+  version "1.0.6"
+  resolved "https://registry.yarnpkg.com/uc.micro/-/uc.micro-1.0.6.tgz#9c411a802a409a91fc6cf74081baba34b24499ac"
+  integrity sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA==
+
 unbox-primitive@^1.0.2:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/unbox-primitive/-/unbox-primitive-1.0.2.tgz#29032021057d5e6cdbd08c5129c226dff8ed6f9e"