From cacc9faceee9d33b5e0022d2abd5159fe30d1580 Mon Sep 17 00:00:00 2001 From: Sven Greb Date: Thu, 12 May 2022 10:26:12 +0200 Subject: [PATCH] Update to `tmpl` template repository version `0.11.0` (#87) Updated to `tmpl` version `0.11.0` [1], including the versions in between starting from 0.10.0 [2]: 1. Optimized GitHub action workflow scope [3]. 2. Updated Node.js packages & GitHub actions [4] [^1] [^2]. 3. Opts-in the Dependabot version update configuration [5]. 4. Migrated to Markdown style guide version 0.4.0 [6]. This also includes changes required for any linter matches. [1]: https://github.com/svengreb/tmpl/releases/tag/v0.11.0 [2]: https://github.com/svengreb/tmpl/releases/tag/v0.10.0 [3]: https://github.com/svengreb/tmpl/issues/84 [4]: https://github.com/svengreb/tmpl/issues/86 [5]: https://github.com/svengreb/tmpl/issues/94 [6]: https://github.com/svengreb/tmpl/issues/76 [^1]: https://github.com/svengreb/tmpl/issues/78 [^2]: https://github.com/svengreb/tmpl/issues/83 Co-authored-by: Sven Greb GH-86 --- .github/dependabot.yml | 40 ------------------- .github/workflows/{ci.yml => ci-node.yaml} | 31 +++++++++----- README.md | 2 +- assets/images/badge.ai | 0 assets/images/badge.svg | 0 .../eslint-config-base/repository-hero.ai | 0 .../eslint-config-base/repository-hero.svg | 0 .../repository-hero.ai | 0 .../repository-hero.svg | 0 .../eslint-config/repository-hero.ai | 0 .../eslint-config/repository-hero.svg | 0 assets/images/repository-hero.ai | 0 assets/images/repository-hero.svg | 0 package.json | 16 ++++---- 14 files changed, 32 insertions(+), 57 deletions(-) delete mode 100644 .github/dependabot.yml rename .github/workflows/{ci.yml => ci-node.yaml} (61%) mode change 100755 => 100644 assets/images/badge.ai mode change 100755 => 100644 assets/images/badge.svg mode change 100755 => 100644 assets/images/packages/@arcticicestudio/eslint-config-base/repository-hero.ai mode change 100755 => 100644 assets/images/packages/@arcticicestudio/eslint-config-base/repository-hero.svg mode change 100755 => 100644 assets/images/packages/@arcticicestudio/eslint-config-typescript/repository-hero.ai mode change 100755 => 100644 assets/images/packages/@arcticicestudio/eslint-config-typescript/repository-hero.svg mode change 100755 => 100644 assets/images/packages/@arcticicestudio/eslint-config/repository-hero.ai mode change 100755 => 100644 assets/images/packages/@arcticicestudio/eslint-config/repository-hero.svg mode change 100755 => 100644 assets/images/repository-hero.ai mode change 100755 => 100644 assets/images/repository-hero.svg diff --git a/.github/dependabot.yml b/.github/dependabot.yml deleted file mode 100644 index 4b12a01..0000000 --- a/.github/dependabot.yml +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright (c) 2018-present Arctic Ice Studio -# Copyright (c) 2018-present Sven Greb -# This source code is licensed under the MIT license found in the LICENSE file. - -# Configuration for the native Dependabot integration. -# -# References: -# 1. https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/configuration-options-for-dependency-updates -# 2. https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/about-dependabot-version-updates -# 3. https://docs.github.com/en/free-pro-team@latest/github/managing-security-vulnerabilities/about-dependabot-security-updates -# 4. https://github.com/features#features-security - -version: 2 -updates: - - package-ecosystem: "github-actions" - directory: "/" - schedule: - interval: "weekly" - reviewers: - - "arcticicestudio" - - "svengreb" - labels: - - "scope-quality" - - "scope-security" - - "target-base" - - - package-ecosystem: "npm" - directory: "/" - schedule: - interval: "monthly" - allow: - # Check all explicitly defined dependencies. - - dependency-type: "direct" - reviewers: - - "arcticicestudio" - - "svengreb" - labels: - - "scope-quality" - - "scope-security" - - "target-base" diff --git a/.github/workflows/ci.yml b/.github/workflows/ci-node.yaml similarity index 61% rename from .github/workflows/ci.yml rename to .github/workflows/ci-node.yaml index c460ee5..23d7610 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci-node.yaml @@ -1,20 +1,32 @@ -# Copyright (c) 2018-present Arctic Ice Studio # Copyright (c) 2018-present Sven Greb # This source code is licensed under the MIT license found in the LICENSE file. # GitHub Action Workflow for continuous integration jobs. # See https://docs.github.com/en/actions and https://github.com/features/actions for more details. -name: ci +name: ci-node on: push: + paths: + - "**.js" + - "**.json" + - "**.md" + - "**.yaml" + - "**.yml" branches: - main tags: - v* pull_request: + paths: + - "**.js" + - "**.json" + - "**.md" + - "**.yaml" + - "**.yml" + jobs: - lint-node: + lint: runs-on: ubuntu-latest steps: - name: Print metadata and context information @@ -24,11 +36,12 @@ jobs: echo "Workflow Actor: $GITHUB_ACTOR" - name: Checkout repository uses: actions/checkout@v2 - - name: "Setup Node.js version 15" - uses: actions/setup-node@v2.1.5 + - name: Setup Node.js version 16 + uses: actions/setup-node@v2.4.1 with: - node-version: "15" + node-version: "16" + cache: "npm" - name: Install Node modules - run: npm install - - name: Run linters - run: npm run lint + run: npm install --no-package-lock + - name: Run linters in CI/CD mode + run: npm run lint:ci diff --git a/README.md b/README.md index d52e58a..4802350 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@

-

+

Every major open source project has its own style guide, a set of standards and conventions for the writing and design of code, documentations and assets. It is much easier to understand a large codebase when all the code in it is in a consistent style. diff --git a/assets/images/badge.ai b/assets/images/badge.ai old mode 100755 new mode 100644 diff --git a/assets/images/badge.svg b/assets/images/badge.svg old mode 100755 new mode 100644 diff --git a/assets/images/packages/@arcticicestudio/eslint-config-base/repository-hero.ai b/assets/images/packages/@arcticicestudio/eslint-config-base/repository-hero.ai old mode 100755 new mode 100644 diff --git a/assets/images/packages/@arcticicestudio/eslint-config-base/repository-hero.svg b/assets/images/packages/@arcticicestudio/eslint-config-base/repository-hero.svg old mode 100755 new mode 100644 diff --git a/assets/images/packages/@arcticicestudio/eslint-config-typescript/repository-hero.ai b/assets/images/packages/@arcticicestudio/eslint-config-typescript/repository-hero.ai old mode 100755 new mode 100644 diff --git a/assets/images/packages/@arcticicestudio/eslint-config-typescript/repository-hero.svg b/assets/images/packages/@arcticicestudio/eslint-config-typescript/repository-hero.svg old mode 100755 new mode 100644 diff --git a/assets/images/packages/@arcticicestudio/eslint-config/repository-hero.ai b/assets/images/packages/@arcticicestudio/eslint-config/repository-hero.ai old mode 100755 new mode 100644 diff --git a/assets/images/packages/@arcticicestudio/eslint-config/repository-hero.svg b/assets/images/packages/@arcticicestudio/eslint-config/repository-hero.svg old mode 100755 new mode 100644 diff --git a/assets/images/repository-hero.ai b/assets/images/repository-hero.ai old mode 100755 new mode 100644 diff --git a/assets/images/repository-hero.svg b/assets/images/repository-hero.svg old mode 100755 new mode 100644 diff --git a/package.json b/package.json index 339b563..d9e4933 100644 --- a/package.json +++ b/package.json @@ -21,8 +21,8 @@ "license": "MIT", "private": true, "engines": { - "node": "^15.13.0", - "npm": "^7.7.0" + "node": ">=15.13", + "npm": ">=7.7" }, "workspaces": [ "packages/@arcticicestudio/*" @@ -38,8 +38,10 @@ "format:fix": "eslint --fix .", "format:pretty": "prettier --write .", "lint": "run-s lint:*", + "lint:ci": "run-s lint:md lint:ci:*", + "lint:ci:pretty": "prettier --loglevel silent --check .", "lint:js": "eslint .", - "lint:md": "remark --no-stdout . .github/**/*.md", + "lint:md": "remark --no-stdout . \".github/**/*.md\"", "lint:pretty": "prettier --check .", "prepare": "run-s prepare:*", "prepare:husky": "husky install", @@ -53,10 +55,10 @@ "eslint-plugin-import": "^2.22.1", "eslint-plugin-prettier": "^3.3.1", "gitbook-cli": "2.3.2", - "husky": "^6.0.0", - "lint-staged": "^10.5.4", + "husky": "^7.0.4", + "lint-staged": "^12.0.4", "npm-run-all": "^4.1.5", - "prettier": "^2.2.1", - "remark-cli": "^9.0.0" + "prettier": "^2.4.1", + "remark-cli": "^10.0.1" } }