diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index a47ed684f..af622ee47 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -10,7 +10,7 @@ on: jobs: spotless: - if: github.repository == 'opensearch-project/opensearch-ai-flow-framework' + if: github.repository == 'opensearch-project/flow-framework' runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 @@ -22,7 +22,7 @@ jobs: - name: Spotless Check run: ./gradlew spotlessCheck javadoc: - if: github.repository == 'opensearch-project/opensearch-ai-flow-framework' + if: github.repository == 'opensearch-project/flow-framework' runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 diff --git a/.github/workflows/publish-snapshots.yml b/.github/workflows/publish-snapshots.yml index 30df5c924..33887585a 100644 --- a/.github/workflows/publish-snapshots.yml +++ b/.github/workflows/publish-snapshots.yml @@ -12,7 +12,7 @@ jobs: build-and-publish-snapshots: strategy: fail-fast: false - if: github.repository == 'opensearch-project/opensearch-ai-flow-framework' + if: github.repository == 'opensearch-project/flow-framework' runs-on: ubuntu-latest permissions: diff --git a/.github/workflows/wrapper.yml b/.github/workflows/wrapper.yml index 8f669c475..063900a64 100644 --- a/.github/workflows/wrapper.yml +++ b/.github/workflows/wrapper.yml @@ -10,7 +10,7 @@ on: jobs: validate: name: Validate - if: github.repository == 'opensearch-project/opensearch-ai-flow-framework' + if: github.repository == 'opensearch-project/flow-framework' runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e1fac7e12..4d2fa07db 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -- [Contributing to OpenSearch AI Flow Framework](#contributing-to-opensearch-ai-flow-framework) +- [Contributing to OpenSearch AI Flow Framework](#contributing-to-flow-framework) - [First Things First](#first-things-first) - [Ways to Contribute](#ways-to-contribute) - [Bug Reports](#bug-reports) @@ -8,13 +8,13 @@ - [Code Coverage](#code-coverage) - [Review Process](#review-process) -# Contributing to OpenSearch AI Flow Framework +# Contributing to OpenSearch Flow Framework OpenSearch AI Flow Framework is a community project that is built and maintained by people just like **you**. We're glad you're interested in helping out. There are several different ways you can do it, but before we talk about that, let's talk about how to get started. ## First Things First -1. **When in doubt, open an issue** - For almost any type of contribution, the first step is opening an issue. Even if you think you already know what the solution is, writing down a description of the problem you're trying to solve will help everyone get context when they review your pull request. If it's truly a trivial change (e.g. spelling error), you can skip this step -- but as the subject says, when in doubt, [open an issue](https://github.com/opensearch-project/opensearch-ai-flow-framework/issues). +1. **When in doubt, open an issue** - For almost any type of contribution, the first step is opening an issue. Even if you think you already know what the solution is, writing down a description of the problem you're trying to solve will help everyone get context when they review your pull request. If it's truly a trivial change (e.g. spelling error), you can skip this step -- but as the subject says, when in doubt, [open an issue](https://github.com/opensearch-project/flow-framework/issues). 2. **Only submit your own work** (or work you have sufficient rights to submit) - Please make sure that any code or documentation you submit is your work or you have the rights to submit. We respect the intellectual property rights of others, and as part of contributing, we'll ask you to sign your contribution with a "Developer Certificate of Origin" (DCO) that states you have the rights to submit this work and you understand we'll use your contribution. There's more information about this topic in the [DCO section](#developer-certificate-of-origin). @@ -24,9 +24,9 @@ OpenSearch AI Flow Framework is a community project that is built and maintained Ugh! Bugs! -A bug is when software behaves in a way that you didn't expect and the developer didn't intend. To help us understand what's going on, we first want to make sure you're working from the latest version. Please make sure you're testing against the [latest version](https://github.com/opensearch-project/opensearch-ai-flow-framework). +A bug is when software behaves in a way that you didn't expect and the developer didn't intend. To help us understand what's going on, we first want to make sure you're working from the latest version. Please make sure you're testing against the [latest version](https://github.com/opensearch-project/flow-framework). -Once you've confirmed that the bug still exists in the latest version, you'll want to check to make sure it's not something we already know about on the [open issues GitHub page](https://github.com/opensearch-project/opensearch-ai-flow-framework/issues). +Once you've confirmed that the bug still exists in the latest version, you'll want to check to make sure it's not something we already know about on the [open issues GitHub page](https://github.com/opensearch-project/flow-framework/issues). ### Feature Requests @@ -34,7 +34,7 @@ If you've thought of a way that this project could be better, we want to hear ab ### Contributing Code -As with other types of contributions, the first step is to [**open an issue on GitHub**](https://github.com/opensearch-project/opensearch-ai-flow-framework/issues/new/choose). Opening an issue before you make changes makes sure that someone else isn't already working on that particular problem. It also lets us all work together to find the right approach before you spend a bunch of time on a PR. So again, when in doubt, open an issue. +As with other types of contributions, the first step is to [**open an issue on GitHub**](https://github.com/opensearch-project/flow-framework/issues/new/choose). Opening an issue before you make changes makes sure that someone else isn't already working on that particular problem. It also lets us all work together to find the right approach before you spend a bunch of time on a PR. So again, when in doubt, open an issue. Once you've opened an issue, check out our [Developer Guide](./DEVELOPER_GUIDE.md) for instructions on how to get started. @@ -69,7 +69,7 @@ By making a contribution to this project, I certify that: consistent with this project or the open source license(s) involved. ``` -We require that every contribution to opensearch-ai-flow-framework is signed with a [Developer Certificate of Origin](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin). Additionally, please use your real name. We do not accept anonymous contributors nor those utilizing pseudonyms. +We require that every contribution to flow-framework is signed with a [Developer Certificate of Origin](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin). Additionally, please use your real name. We do not accept anonymous contributors nor those utilizing pseudonyms. Each commit must include a DCO which looks like this @@ -86,7 +86,7 @@ If you'd like to preview your coverage before submitting your PR, to identify li ## Review Process -We deeply appreciate everyone who takes the time to make a contribution. We will review all contributions as quickly as possible. As a reminder, [opening an issue](https://github.com/opensearch-project/opensearch-ai-flow-framework/issues/new/choose) discussing your change before you make it is the best way to smooth the PR process. This will prevent a rejection because someone else is already working on the problem, or because the solution is incompatible with the architectural direction. +We deeply appreciate everyone who takes the time to make a contribution. We will review all contributions as quickly as possible. As a reminder, [opening an issue](https://github.com/opensearch-project/flow-framework/issues/new/choose) discussing your change before you make it is the best way to smooth the PR process. This will prevent a rejection because someone else is already working on the problem, or because the solution is incompatible with the architectural direction. It is necessary to request at least two contributors to review your pull request. It is required to have two approvals in order for your pull request to be accepted. diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index a7cb1a0b6..107386c3d 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -66,23 +66,23 @@ snapshots/ └── org └── opensearch └── plugin - └── opensearch-ai-flow-framework + └── opensearch-flow-framework ├── 3.0.0.0-SNAPSHOT │   ├── maven-metadata.xml │   ├── maven-metadata.xml.md5 │   ├── maven-metadata.xml.sha1 │   ├── maven-metadata.xml.sha256 │   ├── maven-metadata.xml.sha512 - │   ├── opensearch-ai-flow-framework-3.0.0.0-20231005.170838-1.pom - │   ├── opensearch-ai-flow-framework-3.0.0.0-20231005.170838-1.pom.md5 - │   ├── opensearch-ai-flow-framework-3.0.0.0-20231005.170838-1.pom.sha1 - │   ├── opensearch-ai-flow-framework-3.0.0.0-20231005.170838-1.pom.sha256 - │   ├── opensearch-ai-flow-framework-3.0.0.0-20231005.170838-1.pom.sha512 - │   ├── opensearch-ai-flow-framework-3.0.0.0-20231005.170838-1.zip - │   ├── opensearch-ai-flow-framework-3.0.0.0-20231005.170838-1.zip.md5 - │   ├── opensearch-ai-flow-framework-3.0.0.0-20231005.170838-1.zip.sha1 - │   ├── opensearch-ai-flow-framework-3.0.0.0-20231005.170838-1.zip.sha256 - │   └── opensearch-ai-flow-framework-3.0.0.0-20231005.170838-1.zip.sha512 + │   ├── opensearch-flow-framework-3.0.0.0-20231005.170838-1.pom + │   ├── opensearch-flow-framework-3.0.0.0-20231005.170838-1.pom.md5 + │   ├── opensearch-flow-framework-3.0.0.0-20231005.170838-1.pom.sha1 + │   ├── opensearch-flow-framework-3.0.0.0-20231005.170838-1.pom.sha256 + │   ├── opensearch-flow-framework-3.0.0.0-20231005.170838-1.pom.sha512 + │   ├── opensearch-flow-framework-3.0.0.0-20231005.170838-1.zip + │   ├── opensearch-flow-framework-3.0.0.0-20231005.170838-1.zip.md5 + │   ├── opensearch-flow-framework-3.0.0.0-20231005.170838-1.zip.sha1 + │   ├── opensearch-flow-framework-3.0.0.0-20231005.170838-1.zip.sha256 + │   └── opensearch-flow-framework-3.0.0.0-20231005.170838-1.zip.sha512 ├── maven-metadata.xml ├── maven-metadata.xml.md5 ├── maven-metadata.xml.sha1 diff --git a/build.gradle b/build.gradle index 1b854d91e..880c8d903 100644 --- a/build.gradle +++ b/build.gradle @@ -94,8 +94,8 @@ publishing { } developers { developer { - name = "OpenSearch AI Flow Framework Plugin" - url = "https://github.com/opensearch-project/opensearch-ai-flow-framework" + name = "OpenSearch Flow Framework Plugin" + url = "https://github.com/opensearch-project/flow-framework" } } } diff --git a/src/main/java/org/opensearch/flowframework/workflow/GetMLTaskStep.java b/src/main/java/org/opensearch/flowframework/workflow/GetMLTaskStep.java index ac84aaaa0..bf950f280 100644 --- a/src/main/java/org/opensearch/flowframework/workflow/GetMLTaskStep.java +++ b/src/main/java/org/opensearch/flowframework/workflow/GetMLTaskStep.java @@ -51,7 +51,7 @@ public CompletableFuture execute(List data) { ActionListener actionListener = ActionListener.wrap(response -> { // TODO : Add retry capability if response status is not COMPLETED : - // https://github.com/opensearch-project/opensearch-ai-flow-framework/issues/158 + // https://github.com/opensearch-project/flow-framework/issues/158 logger.info("ML Task retrieval successful"); getMLTaskFuture.complete( diff --git a/src/main/java/org/opensearch/flowframework/workflow/ProcessNode.java b/src/main/java/org/opensearch/flowframework/workflow/ProcessNode.java index 6e3a7bc6d..729043074 100644 --- a/src/main/java/org/opensearch/flowframework/workflow/ProcessNode.java +++ b/src/main/java/org/opensearch/flowframework/workflow/ProcessNode.java @@ -180,7 +180,7 @@ public CompletableFuture execute() { this.future.completeExceptionally(e); } // TODO: improve use of thread pool beyond generic - // https://github.com/opensearch-project/opensearch-ai-flow-framework/issues/61 + // https://github.com/opensearch-project/flow-framework/issues/61 }, threadPool.generic()); return this.future; } diff --git a/src/main/java/org/opensearch/flowframework/workflow/RegisterRemoteModelStep.java b/src/main/java/org/opensearch/flowframework/workflow/RegisterRemoteModelStep.java index d91cfc0e8..de889b720 100644 --- a/src/main/java/org/opensearch/flowframework/workflow/RegisterRemoteModelStep.java +++ b/src/main/java/org/opensearch/flowframework/workflow/RegisterRemoteModelStep.java @@ -87,7 +87,7 @@ public void onFailure(Exception e) { String description = null; String connectorId = null; - // TODO : Handle inline connector configuration : https://github.com/opensearch-project/opensearch-ai-flow-framework/issues/149 + // TODO : Handle inline connector configuration : https://github.com/opensearch-project/flow-framework/issues/149 for (WorkflowData workflowData : data) {