diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 4b0ea22a381..887c3658836 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -214,7 +214,7 @@ jobs: echo -e "### Git status" >> $GITHUB_STEP_SUMMARY if [[ "$changed" -gt 0 ]]; then - echo -e "Generated proto files are out of date. Please run 'make proto' and commit the changes." >> $GITHUB_STEP_SUMMARY + echo -e "Generated proto files are out of date. Please run 'mage proto' and commit the changes." >> $GITHUB_STEP_SUMMARY git status -s -uno >> $GITHUB_STEP_SUMMARY diff --git a/client/python/CONTRIBUTING.md b/client/python/CONTRIBUTING.md index ca3c0f1f90d..ff015d4284e 100644 --- a/client/python/CONTRIBUTING.md +++ b/client/python/CONTRIBUTING.md @@ -26,7 +26,7 @@ workflow for contributing. First time contributors can follow the guide below to Unlike most python projects, the Armada python client contains a large quantity of generated code. This code must be generated in order to compile and develop against the client. -From the root of the repository, run `make python`. This will generate python code needed to build +From the root of the repository, run `mage buildPython`. This will generate python code needed to build and use the client. This command needs to be re-run anytime an API change is committed (e.g. a change to a `*.proto` file). diff --git a/client/python/README.md b/client/python/README.md index 92ed96b26b8..ea4f1409fb2 100644 --- a/client/python/README.md +++ b/client/python/README.md @@ -26,5 +26,5 @@ Before beginning, ensure you have: - Network access to fetch docker images and go dependencies. To generate all needed code, and install the python client: -1) From the root of the repository, run `make python` +1) From the root of the repository, run `mage buildPython` 2) Install the client using `pip install client/python`. It's strongly recommended you do this inside a virtualenv. diff --git a/client/python/docs/README.md b/client/python/docs/README.md index 056327c87ae..d8a7abfe1a0 100644 --- a/client/python/docs/README.md +++ b/client/python/docs/README.md @@ -9,13 +9,13 @@ Usage Easy way: - Ensure all protobufs files needed for the client are generated by running - `make python` from the repository root. + `mage buildPython` from the repository root. - `tox -e docs` will create a valid virtual environment and use it to generate documentation. The generated files will be placed under `build/jekyll/*.md`. Manual way: - Ensure all protobufs files needed for the client are generated by running - `make python` from the repository root. + `mage buildPython` from the repository root. - Create a virtual environment containing all the deps listed in `tox.ini` under `[testenv:docs]`. - Run `poetry install -v` from inside `client/python` to install the client diff --git a/docs/developer/manual-localdev.md b/docs/developer/manual-localdev.md index 236995857c7..65c19e2faad 100644 --- a/docs/developer/manual-localdev.md +++ b/docs/developer/manual-localdev.md @@ -28,7 +28,7 @@ mage BootstrapTools # Compile .pb.go files from .proto files # (only necessary after changing a .proto file). mage proto -make dotnet +mage dotnet # Build the Docker images containing all Armada components. # Only the main "bundle" is needed for quickly testing Armada. diff --git a/magefiles/linting.go b/magefiles/linting.go index bc7094cebff..e301850e93c 100644 --- a/magefiles/linting.go +++ b/magefiles/linting.go @@ -63,7 +63,7 @@ func LintFix() error { } // Linting Check -func CheckLint() error { +func LintCheck() error { mg.Deps(golangciLintCheck) cmd, err := go_TEST_CMD() if err != nil {