Skip to content

Commit

Permalink
Magefile: Clean all Makefile refernces (#2957)
Browse files Browse the repository at this point in the history
* tiny naming change

* clean all make refernces

Signed-off-by: mohamed <mohamedabdelfatah2027@gmail.com>

---------

Signed-off-by: mohamed <mohamedabdelfatah2027@gmail.com>
  • Loading branch information
Mo-Fatah committed Sep 12, 2023
1 parent 2457da7 commit 2c9e497
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion client/python/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion client/python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 2 additions & 2 deletions client/python/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/developer/manual-localdev.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion magefiles/linting.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down

0 comments on commit 2c9e497

Please sign in to comment.