Skip to content

Commit e29ab2e

Browse files
Updates dev guide to inform the workflow approval step (opensearch-project#3062) (opensearch-project#3117)
* Updates dev guide to inform the workflow approval step Signed-off-by: Brian Flores <iflorbri@amazon.com> * Adjusted reason for workflow approval Signed-off-by: Brian Flores <iflorbri@amazon.com> --------- Signed-off-by: Brian Flores <iflorbri@amazon.com> (cherry picked from commit 09ee93f) Co-authored-by: Brian Flores <iflorbri@amazon.com>
1 parent fa0652b commit e29ab2e

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

DEVELOPER_GUIDE.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ This guide applies to the development within the ML-Commons project
1111
- [Build](#Build)
1212
- [Building from the command line](#Building-from-the-command-line)
1313
- [Debugging](#Debugging)
14+
- [GitHub CI/CD workflow Approval](#github-cicd-workflow-approval)
1415
- [More documentation](#More-docs)
1516
- [Code guidelines](#code-guidelines)
1617

@@ -100,7 +101,7 @@ This package uses the [Gradle](https://docs.gradle.org/current/userguide/usergui
100101
11. `./gradlew adBwcCluster#fullRestartClusterTask -Dtests.security.manager=false` launches a cluster with three nodes of bwc version of OpenSearch with anomaly-detection and job-scheduler and tests backwards compatibility by performing a full restart on the cluster upgrading all the nodes with the current version of OpenSearch with anomaly-detection and job-scheduler.
101102
12. `./gradlew bwcTestSuite -Dtests.security.manager=false` runs all the above bwc tests combined.
102103

103-
When launching a cluster using one of the above commands logs are placed in `/build/cluster/run node0/opensearch-<version>/logs`. Though the logs are teed to the console, in practices it's best to check the actual log file.
104+
When launching a cluster using one of the above commands logs are placed in `/build/cluster/run node0/opensearch-<version>/logs`. Though the logs are tied to the console, in practices it's best to check the actual log file.
104105

105106
#### Debugging
106107

@@ -122,6 +123,13 @@ To debug code running in an integ test (which exercises the server from a separa
122123

123124
The test runner JVM will start suspended and wait for a debugger to attach to `localhost:5005` before running the tests.
124125

126+
## GitHub CI/CD workflow Approval
127+
Effective October 2, 2024, maintainer approval will be required to run GitHub CI/CD workflow actions when pushing a pull request (PR).
128+
129+
This change is being implemented as part of our enhanced security measures. We appreciate your patience and cooperation.
130+
131+
For a list of current maintainers, please refer to [MAINTAINERS.md](https://github.com/opensearch-project/ml-commons/blob/main/MAINTAINERS.md).
132+
125133
## More docs
126134

127135
1. [Model serving framework](https://opensearch.org/docs/latest/ml-commons-plugin/model-serving-framework/)

0 commit comments

Comments
 (0)