This repository contains the details and source code for OpenSearch Changelog PR Bridge service, part of the new broader Automated Changelog and Release Notes Process adopted by the OpenSearch Project. It presents comprehensive information on how this service works and interacts with the OpenSearch Changelog Bot and OpenSearch Changelog Workflow, including also guidelines on how to contribute.
For more information about the Automated Changelog and Release Notes Process as a whole, please refer to OpenSearch Changelog Workflow and Release Notes Script repository.
As explained in OpenSearch Changelog Workflow and Release Notes Script, OpenSearch Changelog PR Bridge is a minimal service interacting with OpenSearch Changelog Workflow, used to commit changeset files on behalf of a contributor. The idea behind this is that if a contributor wants to use the option for an Automated Changeset Creation/Update job, then he can install a GitHub App - OpenSearch Changelog Bot - to include this feature in his forked repository. This App, once set up, allows the OpenSearch Changelog PR Bridge to operate on behalf of the contributor, as specific permissions are granted by him during this installation process.
In this manner, when OpenSearch Changelog Workflow service sends a request to the OpenSearch Changelog PR Bridge service, the latter is enabled to commit changeset files to the contributor's repository, as it possesses the necessary permissions for this action. Below is a diagram illustrating this overall process.
In order to use the OpenSearch Changelog Workflow service for automatic creation or update of changeset files in any of your OpenSearch forked repos:
- Navigate to the OpenSearch-bot installation page and click "Install".
- Follow the instructions there and only install this App in all forked OpenSearch repositories where you want to have this feature activated.
In your opened PR, add the changelog entries on your PR description under the ## Changelog`` section. If the entry is valid (i.e., parsing succeeds) or there is not a - skip`` entry, then a valid changeset file will be created on your forked repository. A commit message like the one below will appear in the PR conversation panel of GitHub web UI:
For more references on how to create a valid changelog entry, please refer to OpenSearch Changelog Workflow and Release Notes Script repository.
- Samuel Valdes Gutierrez - OpenSearch Slack link
- Johnathon Bowers - OpenSearch Slack link
The Automated Changelog Release Notes Process is the result of a concerted effort by OpenSearch maintainers and contributors to improve the development experience for all involved in OpenSearch suite.
Contributions to the OpenSearch Changelog PR Bridge are welcome! See our Developer Guide for instructions on how to set up the project in your local environment and CONTRIBUTING.md for guidelines.
This project is an open-source product released under the Apache 2.0 license (see either the Apache site or the LICENSE.txt file). The Apache 2.0 license allows you to freely use, modify, distribute, and sell your own products that include Apache 2.0 licensed software.
Feel free to contact us in the slack channel or by oppening an issue in this repo.