This developer guide includes useful steps to maintain the general health for clients and make them easier to develop and maintain.
Add a DEVELOPER_GUIDE and USER_GUIDE/GETTING_STARTED to help developers and users work with clients.
See opensearch-py for more information.
Add an auto backport workflow to automatically backport pull requests to release branches. This alleviates the manual process of creating backport pull requests.
See backports for more information.
A compatibility matrix gives insight to the users and developers into what versions of the client are compatible with various versions of OpenSearch. To do so, add test support to run integration tests for the client across various versions of OpenSearch to determine compatibility.
See integration workflow and COMPATIBILITY for more information.
Testing clients against unreleased changes of OpenSearch helps getting the clients ready for the next release and figuring out early if a certain change in OpenSearch has broken compatibility with clients.
See unreleased integration for more information.
Create a Github Actions workflow to check for broken links in text files (.md, .html, .txt, .json) on pull requests and push. See .github/workflows/links.yml for an example.
See lycheeverse/lychee-action for more information.
Add Dependabot configuration to the client repository to auto-update dependency versions for the package ecosystem.
See dependabot.yml for more information.