updated readme to reference first release #1

Merged
brian merged 1 commits from release-first-version into main 2025-09-19 21:04:51 +02:00
4 changed files with 21 additions and 20 deletions
Showing only changes of commit 3104d9748a - Show all commits
+6 -6
View File
@@ -27,7 +27,7 @@ on:
jobs:
code-quality:
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/code-quality.yml@main
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/code-quality.yml@v1.0.0
```
### Advanced Usage with Custom Inputs
@@ -43,7 +43,7 @@ on:
jobs:
code-quality:
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/code-quality.yml@main
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/code-quality.yml@v1.0.0
with:
python-version: "3.11"
working-directory: "./backend"
@@ -78,7 +78,7 @@ Your Python project should have:
```yaml
jobs:
code-quality:
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/code-quality.yml@main
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/code-quality.yml@v1.0.0
with:
skip-mypy: true
```
@@ -88,7 +88,7 @@ jobs:
```yaml
jobs:
code-quality:
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/code-quality.yml@main
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/code-quality.yml@v1.0.0
with:
python-version: "3.11"
uv-extras: "dev,lint"
@@ -99,12 +99,12 @@ jobs:
```yaml
jobs:
backend-quality:
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/code-quality.yml@main
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/code-quality.yml@v1.0.0
with:
working-directory: "./backend"
ml-service-quality:
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/code-quality.yml@main
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/code-quality.yml@v1.0.0
with:
working-directory: "./ml-service"
python-version: "3.11"
+6 -6
View File
@@ -27,7 +27,7 @@ on:
jobs:
test:
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/pytest.yml@main
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/pytest.yml@v1.0.0
with:
coverage-package: "my_package"
```
@@ -44,7 +44,7 @@ on:
jobs:
test:
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/pytest.yml@main
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/pytest.yml@v1.0.0
with:
python-version: "3.11"
coverage-package: "data_store"
@@ -61,7 +61,7 @@ jobs:
```yaml
jobs:
test:
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/pytest.yml@main
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/pytest.yml@v1.0.0
with:
pytest-args: "--verbose"
```
@@ -71,7 +71,7 @@ jobs:
```yaml
jobs:
test:
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/pytest.yml@main
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/pytest.yml@v1.0.0
with:
coverage-package: "myapp"
pytest-args: "--maxfail=1 --tb=short -x"
@@ -83,13 +83,13 @@ jobs:
```yaml
jobs:
backend-tests:
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/pytest.yml@main
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/pytest.yml@v1.0.0
with:
working-directory: "./backend"
coverage-package: "backend_api"
ml-service-tests:
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/pytest.yml@main
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/pytest.yml@v1.0.0
with:
working-directory: "./ml-service"
coverage-package: "ml_models"
+4 -4
View File
@@ -25,7 +25,7 @@ on:
jobs:
formatting:
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/web/formatting.yml@main
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/web/formatting.yml@v1.0.0
```
### Advanced Usage with Custom Options
@@ -40,7 +40,7 @@ on:
jobs:
formatting:
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/web/formatting.yml@main
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/web/formatting.yml@v1.0.0
with:
working-directory: "./frontend"
node-version: "18"
@@ -63,13 +63,13 @@ on:
jobs:
python-quality:
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/code-quality.yml@main
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/code-quality.yml@v1.0.0
with:
python-version: "3.12"
working-directory: "./backend"
web-formatting:
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/web/formatting.yml@main
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/web/formatting.yml@v1.0.0
with:
working-directory: "./frontend"
check-yaml: true
+5 -4
View File
@@ -56,7 +56,7 @@ on: [push, pull_request]
jobs:
python-quality:
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/code-quality.yml@main
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/code-quality.yml@v1.0.0
```
### For Web/General Projects
@@ -68,7 +68,7 @@ on: [push, pull_request]
jobs:
formatting:
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/web/formatting.yml@main
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/web/formatting.yml@v1.0.0
```
### For Mixed Projects
@@ -80,12 +80,13 @@ on: [push, pull_request]
jobs:
python-quality:
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/code-quality.yml@main
code-quality:
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/python/[email protected]
with:
working-directory: "./backend"
web-formatting:
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/web/formatting.yml@main
uses: gitea.gt-proj.com/brian/CI-templates/.gitea/workflows/web/formatting.yml@v1.0.0
with:
working-directory: "./frontend"
```