From 9b7b6f468813944a739627bf7026ffcb6ddb5e06 Mon Sep 17 00:00:00 2001 From: Parker Lougheed Date: Wed, 7 Feb 2024 21:10:59 -0600 Subject: [PATCH] Minor README fixes and dependency updates --- .github/PULL_REQUEST_TEMPLATE.md | 4 ++-- .github/dependabot.yml | 17 +++++------------ README.md | 27 ++++++++++++--------------- package.json | 6 +++--- pnpm-lock.yaml | 22 +++++++++++----------- 5 files changed, 33 insertions(+), 43 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b35f63b384..d35cac11d9 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -5,8 +5,8 @@ Fixes --- - [ ] I’ve reviewed the contributor guide and applied the relevant portions to this PR. -- [ ] This PR doesn’t contain automatically generated corrections or text (Grammarly, LLMs, and similar). -- [ ] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style) — for example, it doesn’t use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person). +- [ ] This PR doesn't contain automatically generated corrections or text (Grammarly, LLMs, and similar). +- [ ] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style) — for example, it doesn't use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person). - [ ] This PR uses [semantic line breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks) of 80 characters or fewer.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 67df0aa4e6..8080226429 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,15 +1,8 @@ # Set update schedule for GitHub Actions -# See https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot +# See https://docs.github.com/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot version: 2 updates: - - package-ecosystem: "docker" - directory: "/" - schedule: - interval: "daily" - labels: - - "auto.dependencies" - - "auto.docker" - package-ecosystem: "github-actions" directory: "/" schedule: @@ -23,15 +16,15 @@ updates: schedule: interval: "daily" allow: - - dependency-type: "production" + - dependency-type: "direct" labels: - "auto.dependencies" - "auto.npm" - "lang.javascript" - - package-ecosystem: 'gitsubmodule' - directory: '/' + - package-ecosystem: "gitsubmodule" + directory: "/" schedule: - interval: 'daily' + interval: "daily" labels: - "auto.dependencies" - "auto.submodules" diff --git a/README.md b/README.md index 3c7311ad18..c982d974cb 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ feel free to ask any questions you have on the same issue. To update this site, fork the repo, make your changes, and generate a pull request. -For simple changes (such as style and typo fixes), +For small, contained changes (such as style and typo fixes), you probably don't need to build this site. Often you can make changes using the GitHub UI. We can stage the changes automatically in your pull request. @@ -95,21 +95,19 @@ and then submit a PR from that fork. Once you have a fork (or you're a Dart org member), _choose one_ of the following submodule-cloning techniques: -- Clone the repo and its submodule at the same time - using the `--recurse-submodules` option: +1. Clone the repo and its submodule at the same time + using the `--recurse-submodules` option: - ```terminal - git clone --recurse-submodules https://github.com/dart-lang/site-www.git - ``` - - *OR* + ```terminal + git clone --recurse-submodules https://github.com/dart-lang/site-www.git + ``` -- If you've already cloned the repo without its submodule, - then run this command from the repo root: +2. If you've already cloned the repo without its submodule, + then run this command from the root of the repository: - ```terminal - git submodule update --init --recursive - ``` + ```terminal + git submodule update --init --recursive + ``` > [!NOTE] > At any time during development @@ -170,8 +168,7 @@ following the instructions in [Get the prerequisites](#get-the-prerequisites). 6. View your changes in the browser by navigating to . - > [!NOTE] - > The port might be different if `4000` is taken. + Note the port might be different if `4000` is taken. To instead view the source of generated site files, check the `_site` directory. diff --git a/package.json b/package.json index b60eff5dc1..88dc7efc7c 100644 --- a/package.json +++ b/package.json @@ -15,7 +15,7 @@ }, "engines": { "node": ">=20.10.0", - "pnpm": ">=8.14.0" + "pnpm": ">=8.14.1" }, "packageManager": "pnpm@8.14.3", "dependencies": { @@ -23,7 +23,7 @@ }, "devDependencies": { "@11ty/eleventy": "3.0.0-alpha.4", - "firebase-tools": "^13.0.3", + "firebase-tools": "^13.2.1", "hast-util-from-html": "^2.0.1", "hast-util-select": "^6.0.2", "hast-util-to-html": "^9.0.0", @@ -37,6 +37,6 @@ "markdown-it-deflist": "^3.0.0", "markdown-it-table": "^4.1.1", "sass": "^1.70.0", - "shikiji": "^0.10.0" + "shikiji": "^0.10.2" } } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index c90b30c8a8..5e2b698bd6 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -14,8 +14,8 @@ devDependencies: specifier: 3.0.0-alpha.4 version: 3.0.0-alpha.4 firebase-tools: - specifier: ^13.0.3 - version: 13.0.3 + specifier: ^13.2.1 + version: 13.2.1 hast-util-from-html: specifier: ^2.0.1 version: 2.0.1 @@ -56,8 +56,8 @@ devDependencies: specifier: ^1.70.0 version: 1.70.0 shikiji: - specifier: ^0.10.0 - version: 0.10.0 + specifier: ^0.10.2 + version: 0.10.2 packages: @@ -2028,8 +2028,8 @@ packages: - supports-color dev: true - /firebase-tools@13.0.3: - resolution: {integrity: sha512-tGkKQxcN5fH8uFGXtO+6YSHHKT6G7/AAqtOkHQ5bj3jrNi2gGpzUxb7aVzhbr4C7N5gxuifY4R5bcgRriyeNKw==} + /firebase-tools@13.2.1: + resolution: {integrity: sha512-Dx0h9P4m0T1wWz6Yjk+VOZA/Fef1iM09gpbAxBl+2GAO3KcN3kQf8fvhlzkisCqAnVxB8U2rYRI6ZR1JwY+cqQ==} engines: {node: '>=18.0.0 || >=20.0.0'} hasBin: true dependencies: @@ -4653,14 +4653,14 @@ packages: engines: {node: '>=8'} dev: true - /shikiji-core@0.10.0: - resolution: {integrity: sha512-imG+bvRkuNlZUi2q9tMVfegRRouTpDxMFejpfF/6J+bFX3NDKtlW9T9iIAkBYnw4pcCtSwirW0AvkwlQR4wyxg==} + /shikiji-core@0.10.2: + resolution: {integrity: sha512-9Of8HMlF96usXJHmCL3Gd0Fcf0EcyJUF9m8EoAKKd98mHXi0La2AZl1h6PegSFGtiYcBDK/fLuKbDa1l16r1fA==} dev: true - /shikiji@0.10.0: - resolution: {integrity: sha512-1dAzIOWbtM7B4Sem5BvE+CEdsebDsRA34SfCxM4qJ4PLgR73ZD92VEtNfbcoZ3xOLSqvtV0J9i4WpCgVsmQteg==} + /shikiji@0.10.2: + resolution: {integrity: sha512-wtZg3T0vtYV2PnqusWQs3mDaJBdCPWxFDrBM/SE5LfrX92gjUvfEMlc+vJnoKY6Z/S44OWaCRzNIsdBRWcTAiw==} dependencies: - shikiji-core: 0.10.0 + shikiji-core: 0.10.2 dev: true /side-channel@1.0.4: