Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
Signed-off-by: Peter Zhu <[email protected]>
  • Loading branch information
peterzhuamazon committed Mar 12, 2024
1 parent 654a5bc commit bfa8739
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions src/manifests_workflow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@

This workflow reacts to version increments in OpenSearch and its components by extracting Gradle properties from project branches. Currently OpenSearch `main`, and `x.y` branches are checked out one-by-one, published to local maven, and their versions extracted using `./gradlew properties`. When a new version is found, a new input manifest is added to [manifests](../../manifests), and [a pull request is opened](../../.github/workflows/manifests.yml) (e.g. [opensearch-build#491](https://github.com/opensearch-project/opensearch-build/pull/491)).

Show information about existing manifests.
### Show information about existing manifests

```bash
./manifests.sh list
```

Check for updates and create any new manifests.
### Check for updates and create any new manifests
* If there are no existing manifests in either the `manifests` or `legacy-manifests` folder, use the manifest templates located in `manifests/templates` as a base to generate new manifests.
* If the requested new manifest version (e.g., 0.10.1) is lower than the lowest existing manifest version (e.g., 1.0.0), again, use the manifest templates located in `manifests/templates` as a base to generate new manifests.
* In other scenarios, always use the latest existing manifest version that is lower than the requested new manifest version as the base to generate new manifests (e.g., Use 2.12.0 to generate 2.12.1, even if 2.13.0 exists).

```bash
./manifests.sh update
Expand Down

0 comments on commit bfa8739

Please sign in to comment.