[Feature] There should be a way for a local developer to know if a change will pass CI gates

opensearch-project / security

🔐 Secure your cluster with TLS, numerous authentication backends, data masking, audit logging as well as role-based access control on indices, documents, and fields

https://opensearch.org/docs/latest/security-plugin/index/

Apache License 2.0

199 stars 277 forks source link

[Feature] There should be a way for a local developer to know if a change will pass CI gates #3045

Open peternied opened 1 year ago

peternied commented 1 year ago

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

stephen-crawford commented 1 year ago

[Triage] This change seems like a reasonable potential change that someone interested in infrastructure could make. Specifically, we could see additions to the precommit workflow. Labeling good first issue and help wanted.

prabhask5 commented 12 months ago

@peternied @scrawfor99 There appears to be another opensource tool called act, that seems to solve this problem completely, but requires an outside download and the download of docker. Is this a valid solution, or do you want something completely built into the repo?

stephen-crawford commented 11 months ago

Hey @prabhask5, we are looking for something inside OpenSearch. Using act executes the github actions locally but does not work without docker.