Document mise tasks for agents
This commit is contained in:
@@ -6,6 +6,12 @@
|
||||
|
||||
@docs/project-conventions.md
|
||||
|
||||
# Commands and tasks
|
||||
|
||||
The project uses [mise](https://mise.jdx.dev/) to manage high level configuration and tasks.
|
||||
|
||||
@docs/available-tasks.md
|
||||
|
||||
<!-- usage-rules-start -->
|
||||
<!-- usage_rules-start -->
|
||||
## usage_rules usage
|
||||
|
||||
@@ -0,0 +1,95 @@
|
||||
## `ci:watch`
|
||||
|
||||
- **Usage**: `ci:watch`
|
||||
|
||||
Watch CI running
|
||||
|
||||
## `dev:console`
|
||||
|
||||
- **Usage**: `dev:console`
|
||||
|
||||
Run the application attached to an IEx console
|
||||
|
||||
## `dev:fix-translations`
|
||||
|
||||
- **Usage**: `dev:fix-translations`
|
||||
|
||||
Fix translation file conflicts
|
||||
|
||||
## `dev:lint`
|
||||
|
||||
- **Usage**: `dev:lint`
|
||||
|
||||
Run static checks for code formatting, translations, quality
|
||||
|
||||
## `dev:outdated`
|
||||
|
||||
- **Usage**: `dev:outdated`
|
||||
|
||||
Show outdated dependencies.
|
||||
|
||||
## `dev:partitioned-test`
|
||||
|
||||
- **Usage**: `dev:partitioned-test <partition_number>`
|
||||
|
||||
Run project tests
|
||||
|
||||
### Arguments
|
||||
|
||||
#### `<partition_number>`
|
||||
|
||||
The number of the partition
|
||||
|
||||
## `dev:precommit`
|
||||
|
||||
- **Usage**: `dev:precommit`
|
||||
|
||||
Run checks before a commit
|
||||
|
||||
## `dev:readme`
|
||||
|
||||
- **Usage**: `dev:readme`
|
||||
|
||||
Render README.md with GitHub Flavored Markdown preview
|
||||
|
||||
## `dev:setup`
|
||||
|
||||
- **Usage**: `dev:setup`
|
||||
|
||||
Setup the local development environment
|
||||
|
||||
## `dev:update`
|
||||
|
||||
- **Usage**: `dev:update`
|
||||
|
||||
Update dependencies
|
||||
|
||||
## `prod:backup`
|
||||
|
||||
- **Usage**: `prod:backup`
|
||||
|
||||
Backup the production database to the local development env
|
||||
|
||||
## `prod:deploy`
|
||||
|
||||
- **Usage**: `prod:deploy`
|
||||
|
||||
Deploy on production and monitor deployment
|
||||
|
||||
## `prod:prune-backups`
|
||||
|
||||
- **Usage**: `prod:prune-backups`
|
||||
|
||||
Remove locally downloaded production database backups
|
||||
|
||||
## `prod:test`
|
||||
|
||||
- **Usage**: `prod:test`
|
||||
|
||||
Run HTTP tests against production
|
||||
|
||||
## `test`
|
||||
|
||||
- Depends: dev:partitioned-test 1, dev:partitioned-test 2
|
||||
|
||||
- **Usage**: `test`
|
||||
Reference in New Issue
Block a user