Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Backport 2.x] Updates dev guide to inform the workflow approval step #3117

Merged
merged 1 commit into from
Oct 16, 2024
Merged

[Backport 2.x] Updates dev guide to inform the workflow approval step #3117

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion DEVELOPER_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ This guide applies to the development within the ML-Commons project
- [Build](#Build)
- [Building from the command line](#Building-from-the-command-line)
- [Debugging](#Debugging)
- [GitHub CI/CD workflow Approval](#github-cicd-workflow-approval)
- [More documentation](#More-docs)
- [Code guidelines](#code-guidelines)

Expand Down Expand Up @@ -100,7 +101,7 @@ This package uses the [Gradle](https://docs.gradle.org/current/userguide/usergui
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.
12. `./gradlew bwcTestSuite -Dtests.security.manager=false` runs all the above bwc tests combined.

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.
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.

#### Debugging

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

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

## GitHub CI/CD workflow Approval
Effective October 2, 2024, maintainer approval will be required to run GitHub CI/CD workflow actions when pushing a pull request (PR).

This change is being implemented as part of our enhanced security measures. We appreciate your patience and cooperation.

For a list of current maintainers, please refer to [MAINTAINERS.md](https://github.com/opensearch-project/ml-commons/blob/main/MAINTAINERS.md).

## More docs

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