Add test case to Ninja README and project page

opral · Mar 21, 2024 · 2dc0561 · 2dc0561
1 parent 2f41951
commit 2dc0561
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/inlang/source-code/github-lint-action/MARKETPLACE.md b/inlang/source-code/github-lint-action/MARKETPLACE.md
@@ -47,6 +47,18 @@ jobs:
 
 **Note:** The `opral/ninja-i18n-action` is tagged to always use the latest commit on `main`. This ensures that you always get the latest version of the action. Since the repository is only used for publishing the action, it is safe to use the `main` branch.
 
+### Test if it works
+
+Create a pull request with changes to your i18n files and see if the action runs and creates a comment with the issues report:
+
+1. Create a new `test-ninja` branch in your repository
+2. Open the `test-ninja` branch in [Fink localization editor](https://fink.inlang.com) and delete a translation for testing purposes
+3. Commit and push the change
+4. Create a pull request from the `test-ninja` branch to `main`
+5. Check if the action runs and creates a comment with the issues report
+
+[Click here to watch a video showing the above steps in GitHub](https://www.loom.com/share/c4d15fefb0854ca4b75a85cdb0d2c7e3)
+
 ### Environmental Variables:
 
 | Name                  | Requirement | Description |

diff --git a/inlang/source-code/github-lint-action/README.md b/inlang/source-code/github-lint-action/README.md
@@ -45,6 +45,18 @@ jobs:
 
 **Note:** The `opral/ninja-i18n-action` is tagged to always use the latest commit on `main`. This ensures that you always get the latest version of the action. Since the repository is only used for publishing the action, it is safe to use the `main` branch.
 
+### Test if it works
+
+Create a pull request with changes to your i18n files and see if the action runs and creates a comment with the issues report:
+
+1. Create a new `test-ninja` branch in your repository
+2. Open the `test-ninja` branch in [Fink localization editor](https://fink.inlang.com) and delete a translation for testing purposes
+3. Commit and push the change
+4. Create a pull request from the `test-ninja` branch to `main`
+5. Check if the action runs and creates a comment with the issues report
+
+[Click here to watch a video showing the above steps in GitHub](https://www.loom.com/share/c4d15fefb0854ca4b75a85cdb0d2c7e3)
+
 ### Environmental Variables:
 
 | Name                  | Requirement | Description |