META.md

• Managing OpenSearch Clients
  • Install GH
  • Install Meta
  • Check Out Clients
  • Get Repo Info
  • Add a New Client
  • Create or Update Labels in All Client Repos
  • Create an Issue in All Client Repos
  • Open a Pull Request in Each Repo

Managing OpenSearch Clients

We use meta to manage OpenSearch clients as a set.

Install GH

Install and configure GitHub CLI from github.com/cli/cli. Authenticate with gh auth login and ensure that it works, e.g. gh issue list.

Install Meta

npm install -g meta

See package.json for all dependencies being installed.

Check Out Clients

cd clients
meta git update

Use meta git pull to subsequently pull the latest revisions.

Get Repo Info

clients> meta gh issue list

Add a New Client

cd clients
meta project import opensearch-new-client git@github.com:opensearch-project/opensearch-new-client.git

Create or Update Labels in All Client Repos

Install ghi, e.g. brew install ghi.

meta exec "ghi label 'backwards-compatibility' -c '#773AA8'

This makes it easy to create version labels.

meta exec "ghi label 'untriaged' -c '#fbca04'"
meta exec "ghi label 'v1.0.0' -c '#d4c5f9'"
meta exec "ghi label 'v1.1.0' -c '#c5def5'"
meta exec "ghi label 'v2.0.0' -c '#b94c47'"

Create an Issue in All Client Repos

Create a file for the issue body, e.g. issue.md.

meta exec "gh issue create --label backwards-compatibility --title 'Ensure backwards compatibility with ODFE' --body-file ../issue.md"

Open a Pull Request in Each Repo

In opensearch-build#497 we needed to remove integtest.sh from each repo.

We'll be pushing to forks. Make sure to replace username with your GitHub username below and to fork all the repos first.

meta exec "gh repo fork"

Ensure that a remote is setup for each client pointing to our forks.

meta exec "git remote get-url origin | sed s/opensearch-project/username/g | xargs git remote add username"

Remove a file, e.g. integtest.sh, commit and push.

meta exec "git rm integtest.sh"
meta exec "git add --all"
meta exec "git checkout -b remove-integtest-sh"
meta exec "git commit -s -m 'Removed integtest.sh.'"
meta exec "git push username remove-integtest-sh"
meta exec "gh pr create --title 'Removing default integtest.sh.' --body='Coming from https://github.com/opensearch-project/opensearch-build/issues/497, removing default integtest.sh.'"