Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CI] Replace npm with make commands and use them in workflows #950

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

shinigami-777
Copy link

Notes for Reviewers

This PR fixes #942 .

  • Created make targets reusing the include() Makefile.show-help.mk file from meshery/meshery.
  • These are the following make commands:
    meshery1
  • Updated README.md and CONTRIBUTING.md accordingly.
  • Updated Github workflows to use make commands.

Signed commits

  • Yes, I signed my commits.

…efile

Signed-off-by: shinigami-777 <chattopadhyaytamaghna@gmail.com>
Signed-off-by: shinigami-777 <chattopadhyaytamaghna@gmail.com>
Signed-off-by: shinigami-777 <chattopadhyaytamaghna@gmail.com>
@github-actions github-actions bot added the area/ci Continuous integration | Build and release label Mar 1, 2025
@shinigami-777
Copy link
Author

@leecalcote I have tested that all the mentioned make commands are working and the workflow runs are successful on my branch. https://github.com/shinigami-777/sistent/actions/runs/13609283622

@leecalcote
Copy link
Member

Running workflows...


- name: Run Tests
run: npm run test
run: make run-tests
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Invert please. Noun first, verb second.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Renamed to test-run

Makefile Outdated
npm run build

package-build-watch: setup
## Buid Sistent in watch mode
build-watch:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs renamed.

Copy link
Author

@shinigami-777 shinigami-777 Mar 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Renamed it to watch-build. Does this work?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

verb-verb? No, it does not work. Refer to our other projects for examples.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I referred to the examples but was unable to find an exact case (it did help me understand the naming scheme) Suggesting a few as I'm not very confident with my naming...dev-build , watchmode-build, watcher-build. Do these work?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Renamed it to watchmode-build.

Makefile Outdated
npm run lint

## Run tests
run-tests:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rename

npm run format:write

## Run Eslint on your local machine
lint:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need two separate commands for formatting and linting? Combine them?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, combined both under a single make lint command.

Signed-off-by: shinigami-777 <chattopadhyaytamaghna@gmail.com>
Signed-off-by: shinigami-777 <chattopadhyaytamaghna@gmail.com>
@shinigami-777 shinigami-777 requested a review from leecalcote March 7, 2025 21:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/ci Continuous integration | Build and release
Development

Successfully merging this pull request may close these issues.

[CI] Use make, not npm directly
2 participants