Add API Changelog #4612
Merged
Add API Changelog #4612
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 tasks
shawnxie999
approved these changes
Jul 18, 2023
ckeshava
approved these changes
Jul 18, 2023
This was referenced Aug 18, 2023
Closed
Closed
Merged
ckeshava
pushed a commit
to ckeshava/rippled
that referenced
this pull request
Sep 22, 2023
Introduce an API Changelog, which logs the changes that have been made to the API. Without this changelog, it is difficult to keep track of the changes and additions that are made to the API. While all changes are surfaced in PRs and Release Notes, these are mixed in with other non-API-affecting changes. PRs that affect the API have the `API Change` label applied, but it is hard to identify which PRs have been included in each release. Furthermore, some API changes will take effect based on `api_version` (starting with rippled version 1.12, which will introduce `api_version: 2`), while others are based on the `rippled` version. The API Changelog clarifies the details of the changes in a way that is easily understood by API consumers, and breaks down the changes to be clear which ones are gated by api_version (versus `rippled` version). From now on, all PR authors are responsible for updating the API Changelog according to the additions/changes that their PR makes to the APIs.
ckeshava
pushed a commit
to ckeshava/rippled
that referenced
this pull request
Sep 25, 2023
Introduce an API Changelog, which logs the changes that have been made to the API. Without this changelog, it is difficult to keep track of the changes and additions that are made to the API. While all changes are surfaced in PRs and Release Notes, these are mixed in with other non-API-affecting changes. PRs that affect the API have the `API Change` label applied, but it is hard to identify which PRs have been included in each release. Furthermore, some API changes will take effect based on `api_version` (starting with rippled version 1.12, which will introduce `api_version: 2`), while others are based on the `rippled` version. The API Changelog clarifies the details of the changes in a way that is easily understood by API consumers, and breaks down the changes to be clear which ones are gated by api_version (versus `rippled` version). From now on, all PR authors are responsible for updating the API Changelog according to the additions/changes that their PR makes to the APIs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
High Level Overview of Change
Introduce an API Changelog, which logs the changes that have been made to the API.
Context of Change
It is currently difficult to keep track of the changes and additions that are made to the rippled API. While all changes are surfaced in PRs and Release Notes, these are mixed in with other non-API-affecting changes. PRs that affect the API have the
API Changelabel applied, but it is hard to identify which PRs have been included in each release. Furthermore, some API changes will take effect based onapi_version(starting with rippled version 1.12, which will introduceapi_version: 2), while others are based on the version of rippled.The API Changelog clarifies the details of the changes in a way that is easily understood by API consumers, and breaks down the changes so it's clear which ones are gated by api_version (while others are determined by
rippledversion).Type of Change
Future Tasks
From now on, all PR authors are responsible for updating the API Changelog according to the additions/changes that their PR makes to the APIs.