-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
65 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,3 +15,4 @@ ci_artifacts | |
.DS_Store | ||
artifacts | ||
Taskfile.yml | ||
.obsidian |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,40 +1,15 @@ | ||
## Management tasks | ||
# datalens-backend | ||
|
||
Running tasks: | ||
``` | ||
task <task_name> | ||
``` | ||
## About | ||
|
||
This is the repository for the back-end implementation of DataLens | ||
|
||
### Environment (`env:`) | ||
Head over to the [Knowledge Base](kb/index.md) for documentation on this repo. | ||
|
||
- `task env:devenv`: | ||
Create development/testing environment (run it from a package dir) | ||
- `task env:devenv-d`: | ||
Create development/testing environment in detached mode (run it from a package dir) | ||
- `task env:ensure_venv`: Command to create virtual env for the mainrepo tools. | ||
It requires presence of .env in the mainrepo/tools. | ||
[Code of conduct](CODE_OF_CONDUCT.md) | ||
|
||
[Contributing](CONTRIBUTING.md) | ||
|
||
### Generation (`gen:`) | ||
## License | ||
|
||
- `task gen:antlr`: | ||
(Re-)generate ANTLR code files for formula | ||
- `task gen:i18n-po`: | ||
Sync/generate `.po` files for package (run it from a package dir) | ||
- `task gen:i18n-binaries`: | ||
Generate binary `.mo` files from `.po` files for package (run it from a package dir) | ||
|
||
|
||
### Code quality (`cq:`) | ||
|
||
Experimental tasks to check and fix source files. | ||
|
||
- `task cq:fix_changed`: | ||
Apply all auto-fixes | ||
- `task cq:check_changed`: | ||
Check for any non-conformity in code style/format/lint | ||
- `task cq:fix_dir -- {single dir}`: | ||
Apply all auto-fixes to the given dir absolute path | ||
- `task cq:check_dir -- {single dir}`: | ||
Check for any non-conformity in code style/format/lint in the given dir abs path | ||
`datalens-backend` is available under the Apache 2.0 license. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Datalens Backend Knowledge Base | ||
|
||
Welcome to the KB! | ||
|
||
See: | ||
- [Repository tooling](tooling/index.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Repository Tooling | ||
|
||
This section is about the custom tooling available in this repo. | ||
|
||
- [task commands](task_commands.md) - a set of (`make`-like) shortcuts for various commands and scripts for repository management, development, testing, etc. | ||
- [dl-git](../../terrarium/dl_gitmanager/README.md) - a wrapper for advanced git commands, for usage mainly in the CI workflow | ||
- [dl-repo / dl-package](../../terrarium/dl_repmanager/README.md) - tools for managing and inspecting packages, their dependencies, meta-packages, etc. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
## Management tasks | ||
|
||
These commands require the ``taskfile`` tool. See [this page](https://taskfile.dev/installation/) | ||
for installation options. | ||
|
||
Running tasks: | ||
``` | ||
task <task_name> | ||
``` | ||
|
||
|
||
### Environment (`env:`) | ||
|
||
- `task env:devenv`: | ||
Create development/testing environment (run it from a package dir) | ||
- `task env:devenv-d`: | ||
Create development/testing environment in detached mode (run it from a package dir) | ||
- `task env:ensure_venv`: Command to create virtual env for the mainrepo tools. | ||
It requires presence of .env in the mainrepo/tools. | ||
|
||
|
||
### Generation (`gen:`) | ||
|
||
- `task gen:antlr`: | ||
(Re-)generate ANTLR code files for formula | ||
- `task gen:i18n-po`: | ||
Sync/generate `.po` files for package (run it from a package dir) | ||
- `task gen:i18n-binaries`: | ||
Generate binary `.mo` files from `.po` files for package (run it from a package dir) | ||
|
||
|
||
### Code quality (`cq:`) | ||
|
||
Experimental tasks to check and fix source files. | ||
|
||
- `task cq:fix_changed`: | ||
Apply all auto-fixes | ||
- `task cq:check_changed`: | ||
Check for any non-conformity in code style/format/lint | ||
- `task cq:fix_dir -- {single dir}`: | ||
Apply all auto-fixes to the given dir absolute path | ||
- `task cq:check_dir -- {single dir}`: | ||
Check for any non-conformity in code style/format/lint in the given dir abs path |