Skip to content

Commit ee9ca37

Browse files
committed
Rename task report to project:report
1 parent 79bf180 commit ee9ca37

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

doc/metrics.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Tooling
8484
Projects
8585
________
8686

87-
Projects can run the nox task :code:`nox -s report` to generate their project metrics if they are using the :code:`exasol-toolbox`.
87+
Projects can run the nox task :code:`nox -s project:report` to generate their project metrics if they are using the :code:`exasol-toolbox`.
8888

8989

9090
Development

doc/user_guide/getting_started.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ You are ready to use the toolbox. With *nox -l* you can list all available tasks
192192
- lint:code -> Runs the static code analyzer on the project
193193
- lint:typing -> Runs the type checker on the project
194194
- lint:security -> Runs the security linter on the project
195-
- report -> Collects and generates metrics summary for the workspace
195+
- project:report -> Collects and generates metrics summary for the workspace
196196
- release:prepare -> Prepares the project for a new release.
197197
- unit-tests -> Runs all unit tests
198198
- integration-tests -> Runs the all integration tests

exasol/toolbox/nox/_metrics.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
from noxconfig import PROJECT_CONFIG
1414

1515

16-
@nox.session(name="report", python=False)
16+
@nox.session(name="project:report", python=False)
1717
def report(session: Session) -> None:
1818
"""
1919
Collects and generates metrics summary for the workspace
@@ -32,7 +32,7 @@ def report(session: Session) -> None:
3232
- :code:`nox -s lint`
3333
"""
3434
formats = tuple(fmt.name.lower() for fmt in Format)
35-
usage = "nox -s report -- [options]"
35+
usage = "nox -s project:report -- [options]"
3636
parser = argparse.ArgumentParser(
3737
description="Generates status report for the project", usage=usage
3838
)

exasol/toolbox/templates/github/workflows/report.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ jobs:
3535
cp security-python3.9/.security.json ../
3636
3737
- name: Generate Report
38-
run: poetry run nox -s report -- -- --format json | tee metrics.json
38+
run: poetry run nox -s project:report -- -- --format json | tee metrics.json
3939

4040
- name: Upload Artifacts
4141
uses: actions/[email protected]
@@ -46,7 +46,7 @@ jobs:
4646
- name: Generate GitHub Summary
4747
run: |
4848
echo -e "# Summary\n" >> $GITHUB_STEP_SUMMARY
49-
poetry run nox -s report -- -- --format markdown >> $GITHUB_STEP_SUMMARY
49+
poetry run nox -s project:report -- -- --format markdown >> $GITHUB_STEP_SUMMARY
5050
echo -e "\n\n# Coverage\n" >> $GITHUB_STEP_SUMMARY
5151
poetry run coverage report -- --format markdown >> $GITHUB_STEP_SUMMARY
5252
echo -e "\n\n# Static Code Analysis\n" >> $GITHUB_STEP_SUMMARY

0 commit comments

Comments
 (0)