Skip to content

Commit 09ee93f

Browse files
authoredOct 16, 2024
Updates dev guide to inform the workflow approval step (opensearch-project#3062)
* 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>
1 parent 5b982c4 commit 09ee93f

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

@@ -96,7 +97,7 @@ This package uses the [Gradle](https://docs.gradle.org/current/userguide/usergui
9697
7. `./gradlew integTest -Dtests.rest.cluster=localhost:9200 -Dtests.cluster=localhost:9200 -Dtests.clustername="docker-cluster" -Dhttps=true -Duser=admin -Dpassword=admin` launches integration tests against a local cluster and run tests with security. Detail steps: (1)download OpenSearch tarball to local and install by running `opensearch-tar-install.sh`; (2)build ML plugin zip with your change and install ML plugin zip; (3)restart local test cluster; (4) run this gradle command to test.
9798
8. `./gradlew spotlessApply` formats code. And/or import formatting rules in `.eclipseformat.xml` with IDE.
9899

99-
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.
100+
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.
100101

101102
#### Debugging
102103

@@ -118,6 +119,13 @@ To debug code running in an integ test (which exercises the server from a separa
118119

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

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

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

0 commit comments

Comments
 (0)