opensearch-project / opensearch-project/security
[Feature] There should be a way for a local developer to know if a change will pass CI gates
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 252
- Forks
- 395
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 76
Description
Description
There are many checks used by the PR workflow that validate different aspects of incoming changes. There are hygiene scans, code correctness, code coverage, backward compatibility and DCO. It would be useful to have a way to run all the checks for this repository on your local machine.
What alternatives can be considered?
GitHub Action workflows execute all of the different scans and tests, these can continue to be used.
Additional Context
- From discussion on https://github.com/opensearch-project/security/pull/2935
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the repository's GitHub Action workflows and the checks they run for pull requests. Define what local entry point should invoke those checks and verify that it covers the hygiene, correctness, coverage, compatibility, and DCO checks described in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, java
- Domain
- ci-cd, developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100