41 lines
2.1 KiB
Markdown
41 lines
2.1 KiB
Markdown
# Gemini Actions
|
|
|
|
This repository is maintained by Gemini.
|
|
|
|
## Development Guidelines
|
|
|
|
* **Test-Driven Development (TDD):** Wherever possible, Test-Driven Development principles should be followed. Write tests before writing the code they are intended to validate.
|
|
* **Pre-commit Hooks:** Ensure that `pre-commit` hooks are installed and active before making any commits. This can be done by running `pre-commit install` in your local repository.
|
|
* **Note for Gemini:** Git commits trigger pre-commit hooks, which can take several seconds (or minutes) to complete. Checking the command status for git commit is only appropriate every 120s.
|
|
* **Package Manager Preferences:** Always use `pnpm` and `pnpx`. Never use `npm` or `npx` under any circumstances. All package management operations, script runs, and tool invocations must use `pnpm` / `pnpx`.
|
|
|
|
## Repository Comparison
|
|
|
|
* On request, this repository should be compared against the rules and guidelines specified in the `README.md` of the reference repository: `https://git.horstenkamp.eu/Philipp/template-git`.
|
|
|
|
## Testing
|
|
|
|
This project uses [Vitest](https://vitest.dev/) for testing. The tests are located in the `__tests__` directory.
|
|
|
|
To run the tests locally, use the following command:
|
|
|
|
```bash
|
|
pnpm test
|
|
```
|
|
|
|
### Testing Pipeline
|
|
|
|
The tests are automatically run on every push and workflow dispatch using a Gitea workflow. The workflow is defined in `.gitea/workflows/test.yaml`. All testing for this repository is done via Gitea workflows, not GitHub workflows.
|
|
|
|
The Gitea workflow does the following:
|
|
|
|
1. Checks out the code.
|
|
2. Sets up Node.js and pnpm.
|
|
3. Installs the dependencies using `pnpm install`.
|
|
4. Runs the tests using `pnpm test`.
|
|
|
|
### Automated Recompilation & Permissions
|
|
|
|
* The automated recompilation workflow (`.gitea/workflows/recompile-dist.yaml`) recompiles `dist/index.js` on Renovate PRs and requires `contents: write` permissions to push back to the branch.
|
|
* Ensure that the Gitea repository workflow settings have write permissions enabled (**Settings** ➔ **Actions** ➔ **General** ➔ **Workflow permissions** ➔ **Read and write permissions**).
|