From 25930162f339a7c5c119e7197726ad2507dee75a Mon Sep 17 00:00:00 2001 From: Vijay A Date: Wed, 13 Jul 2022 11:40:00 +0530 Subject: Update documentation [skip ci] --- .github/PULL_REQUEST_TEMPLATE/add_recipe.md | 2 +- .github/workflows/builds.yml | 2 +- .husky/pre-commit | 2 +- docs/integration.md | 2 +- docs/updating.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/add_recipe.md b/.github/PULL_REQUEST_TEMPLATE/add_recipe.md index ca893cc..3756c29 100644 --- a/.github/PULL_REQUEST_TEMPLATE/add_recipe.md +++ b/.github/PULL_REQUEST_TEMPLATE/add_recipe.md @@ -22,7 +22,7 @@ Service ID: [What ID does your recipe use?] - [ ] I am the original creator of this package -- [ ] I have run the `pnpm package` and verified that there are no validation errors reported for this package +- [ ] I have run the `pnpm lint && pnpm reformat-files && pnpm package` and verified that there are no validation errors reported for this package - [ ] My recipe has been tested to work inside Ferdium diff --git a/.github/workflows/builds.yml b/.github/workflows/builds.yml index 4fd4f97..806b2a2 100644 --- a/.github/workflows/builds.yml +++ b/.github/workflows/builds.yml @@ -35,4 +35,4 @@ jobs: - name: Install pnpm run: npm i -gf "pnpm@$(node -p 'require("./package.json").engines.pnpm')" && pnpm -v - name: Install node dependencies recursively - run: pnpm i && pnpm package + run: pnpm i && pnpm lint && pnpm reformat-files && pnpm package diff --git a/.husky/pre-commit b/.husky/pre-commit index b26458b..cf9de02 100755 --- a/.husky/pre-commit +++ b/.husky/pre-commit @@ -1,4 +1,4 @@ #!/bin/sh . "$(dirname "$0")/_/husky.sh" -pnpm lint && pnpm reformat-files && pnpm package +pnpm i && pnpm lint && pnpm reformat-files && pnpm package diff --git a/docs/integration.md b/docs/integration.md index 9ff7011..843597c 100644 --- a/docs/integration.md +++ b/docs/integration.md @@ -53,7 +53,7 @@ This command will automatically create the development recipe in the correct fol 5. (Mandatory) Please run the following step before raising a PR: ```Bash -pnpm package +pnpm i && pnpm lint && pnpm reformat-files && pnpm package ``` Fix any issues that are reported. diff --git a/docs/updating.md b/docs/updating.md index 3b835df..aeb2ffe 100644 --- a/docs/updating.md +++ b/docs/updating.md @@ -31,6 +31,6 @@ Ferdium uses this version to determine if it should update the local copy of the ## 5. Running the validation checks -This might be the __most important step__ of this guide. You'll need to run the `pnpm package` command to ensure that all validation checks are run. +This might be the __most important step__ of this guide. You'll need to run the `pnpm lint && pnpm reformat-files && pnpm package` command to ensure that all validation checks are run. ## 6. Commit your changes and create a PR to -- cgit v1.2.3-70-g09d2