diff options
author | 2022-07-13 11:40:00 +0530 | |
---|---|---|
committer | 2022-07-13 11:44:27 +0530 | |
commit | 25930162f339a7c5c119e7197726ad2507dee75a (patch) | |
tree | 6b11f53a517292216702d6683f919f95acbaf18f | |
parent | Fix lint and prettier (diff) | |
download | ferdium-recipes-25930162f339a7c5c119e7197726ad2507dee75a.tar.gz ferdium-recipes-25930162f339a7c5c119e7197726ad2507dee75a.tar.zst ferdium-recipes-25930162f339a7c5c119e7197726ad2507dee75a.zip |
Update documentation [skip ci]
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE/add_recipe.md | 2 | ||||
-rw-r--r-- | .github/workflows/builds.yml | 2 | ||||
-rwxr-xr-x | .husky/pre-commit | 2 | ||||
-rw-r--r-- | docs/integration.md | 2 | ||||
-rw-r--r-- | 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?] | |||
22 | <!-- Please also accept the following checkboxes --> | 22 | <!-- Please also accept the following checkboxes --> |
23 | 23 | ||
24 | - [ ] I am the original creator of this package | 24 | - [ ] I am the original creator of this package |
25 | - [ ] I have run the `pnpm package` and verified that there are no validation errors reported for this package | 25 | - [ ] I have run the `pnpm lint && pnpm reformat-files && pnpm package` and verified that there are no validation errors reported for this package |
26 | - [ ] My recipe has been tested to work inside Ferdium | 26 | - [ ] My recipe has been tested to work inside Ferdium |
27 | 27 | ||
28 | <!-- Here you can write anything else you want to tell us. --> | 28 | <!-- Here you can write anything else you want to tell us. --> |
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: | |||
35 | - name: Install pnpm | 35 | - name: Install pnpm |
36 | run: npm i -gf "pnpm@$(node -p 'require("./package.json").engines.pnpm')" && pnpm -v | 36 | run: npm i -gf "pnpm@$(node -p 'require("./package.json").engines.pnpm')" && pnpm -v |
37 | - name: Install node dependencies recursively | 37 | - name: Install node dependencies recursively |
38 | run: pnpm i && pnpm package | 38 | 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 @@ | |||
1 | #!/bin/sh | 1 | #!/bin/sh |
2 | . "$(dirname "$0")/_/husky.sh" | 2 | . "$(dirname "$0")/_/husky.sh" |
3 | 3 | ||
4 | pnpm lint && pnpm reformat-files && pnpm package | 4 | 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 | |||
53 | 53 | ||
54 | 5. (Mandatory) Please run the following step before raising a PR: | 54 | 5. (Mandatory) Please run the following step before raising a PR: |
55 | ```Bash | 55 | ```Bash |
56 | pnpm package | 56 | pnpm i && pnpm lint && pnpm reformat-files && pnpm package |
57 | ``` | 57 | ``` |
58 | Fix any issues that are reported. | 58 | Fix any issues that are reported. |
59 | 59 | ||
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 | |||
31 | 31 | ||
32 | ## 5. Running the validation checks | 32 | ## 5. Running the validation checks |
33 | 33 | ||
34 | 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. | 34 | 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. |
35 | 35 | ||
36 | ## 6. Commit your changes and create a PR to <https://github.com/ferdium/ferdium-recipes> | 36 | ## 6. Commit your changes and create a PR to <https://github.com/ferdium/ferdium-recipes> |