From 29d13e8e711e6f08f4c228b1ba1dd5d3204c2230 Mon Sep 17 00:00:00 2001 From: Joel Lefkowitz Date: Fri, 29 Nov 2024 17:15:35 +0000 Subject: [PATCH] Rename yml files to yaml --- .../install/{action.yml => action.yaml} | 0 .github/workflows/{docs.yml => docs.yaml} | 0 .../workflows/{publish.yml => publish.yaml} | 0 .github/workflows/{review.yml => review.yaml} | 0 .trufflehog3.yml => .trufflehog3.yaml | 0 README.md | 36 ++++++++++++------- pyproject.toml | 2 +- src/environment.py | 2 +- 8 files changed, 25 insertions(+), 15 deletions(-) rename .github/actions/install/{action.yml => action.yaml} (100%) rename .github/workflows/{docs.yml => docs.yaml} (100%) rename .github/workflows/{publish.yml => publish.yaml} (100%) rename .github/workflows/{review.yml => review.yaml} (100%) rename .trufflehog3.yml => .trufflehog3.yaml (100%) diff --git a/.github/actions/install/action.yml b/.github/actions/install/action.yaml similarity index 100% rename from .github/actions/install/action.yml rename to .github/actions/install/action.yaml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yaml similarity index 100% rename from .github/workflows/docs.yml rename to .github/workflows/docs.yaml diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yaml similarity index 100% rename from .github/workflows/publish.yml rename to .github/workflows/publish.yaml diff --git a/.github/workflows/review.yml b/.github/workflows/review.yaml similarity index 100% rename from .github/workflows/review.yml rename to .github/workflows/review.yaml diff --git a/.trufflehog3.yml b/.trufflehog3.yaml similarity index 100% rename from .trufflehog3.yml rename to .trufflehog3.yaml diff --git a/README.md b/README.md index 6d12baf..61c7aa5 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ SCons builders. -![Review](https://img.shields.io/github/actions/workflow/status/JoelLefkowitz/miniscons/review.yml) +![Review](https://img.shields.io/github/actions/workflow/status/JoelLefkowitz/miniscons/review.yaml) ![Version](https://img.shields.io/pypi/v/miniscons) ![Downloads](https://img.shields.io/pypi/dw/miniscons) ![Quality](https://img.shields.io/codacy/grade/97f4a968fe554186b58c2f49903a09f4) @@ -19,19 +19,24 @@ When writing an `SConstruct.py` configuration it is difficult to: We can use `miniscons` to keep the `SConstruct.py` file short and get an interface like this: -```yml -builds: build +```yaml +builds: + build tests -targets: start -> build +targets: + start -> build test -> tests -scripts: tidy +scripts: + tidy clean -routines: lint -> [tidy, clean] +routines: + lint -> [tidy, clean] -flags: --dump +flags: + --dump ``` ## Installing @@ -146,21 +151,26 @@ scons --dump We get our interface: -```yml +```yaml scons: Reading SConscript files ... -builds: build +builds: + build tests -targets: start -> build +targets: + start -> build test -> tests -scripts: tidy +scripts: + tidy clean -routines: lint -> [tidy, clean] +routines: + lint -> [tidy, clean] -flags: --dump +flags: + --dump ``` ## Discussion diff --git a/pyproject.toml b/pyproject.toml index 97d7833..04b7c34 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -86,7 +86,7 @@ lint = [ "npx cspell . --dot --gitignore", "pylint src --disable=C0114,C0115,C0116,C0411,C3001 --good-names=x,y,z", "mypy src --ignore-missing-import", - "trufflehog3", + "trufflehog3 -c .trufflehog3.yaml", ] format = [ diff --git a/src/environment.py b/src/environment.py index 1dbff96..3ce0e65 100644 --- a/src/environment.py +++ b/src/environment.py @@ -9,7 +9,7 @@ def conan( defines: list[str] | None = None, source: str = "SConscript_conandeps", -) -> tuple[Environment, list[str]]: +) -> Environment: if defines is None: defines = []