infra(CI): Add more ci infrastructure.
- Dominant language
- Java
- Stars
- 808
- Forks
- 188
- Avg merge
- 3d 22h
- Merged PRs (30d)
- 2
Description
GHA can assist us in conducting some automated checks when contributors submit PRs, to ensure the accuracy and standardization of the submissions. And this is also helpful for code review. Reduce the mental burden on the reviewers.
1. Add License check, for: https://github.com/apache/geaflow/pull/637#discussion_r2445275393;
2. Add markdown lint and check. for: https://github.com/apache/geaflow/blob/master/docs/docs-cn/Makefile;
3. There are still some yml files in the project. We should add some yaml lint.
4. For the front-end project, we should add some npm lint to standardize the front-end code.
5. Add spelling check to prevent spelling mistakes of English words.
I tend to use makefile to build a CI infrastructure system, which is helpful for troubleshooting CI issues locally and is consistent with the commands executed in the CI environment.
such as:
- https://github.com/alibaba/spring-ai-alibaba/blob/main/Makefile
- https://github.com/vllm-project/semantic-router/blob/main/Makefile
btw, This also includes https://github.com/apache/geaflow/issues/642
Contributor guide
Research direction
Review the referenced docs/docs-cn/Makefile and the linked discussion in pull request 637, then compare the repository's YAML files and front-end project. Define a Makefile-based local workflow matching CI for license, Markdown, YAML, npm, and spelling checks. Done means all requested checks run consistently in CI and locally.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- build-system, ci-cd, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100