Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update PULL_REQUEST_TEMPLATE to include an API spec change in the checklist. #1262

Merged

Conversation

dblock
Copy link
Member

@dblock dblock commented Jul 8, 2024

Coming from opensearch-project/opensearch-api-specification#387, update PR template to include a checkbox that requests that all API changes be documented in the OpenAPI spec used to generate clients.

…cklist.

Signed-off-by: dblock <dblock@amazon.com>
Copy link

codecov bot commented Jul 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.08%. Comparing base (3f0fc8c) to head (3e020b9).
Report is 3 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff              @@
##               main    #1262      +/-   ##
============================================
+ Coverage     71.83%   77.08%   +5.25%     
- Complexity     4898     5290     +392     
============================================
  Files           518      517       -1     
  Lines         22879    22890      +11     
  Branches       2245     2239       -6     
============================================
+ Hits          16434    17645    +1211     
+ Misses         5410     4212    -1198     
+ Partials       1035     1033       -2     
Flag Coverage Δ
plugin 77.08% <ø> (+5.25%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 97 files with indirect coverage changes

### Check List
- [ ] New functionality includes testing.
- [ ] New functionality has been documented.
- [ ] API changes companion pull request [created](https://github.com/opensearch-project/opensearch-api-specification/blob/main/DEVELOPER_GUIDE.md).
Copy link
Member

@vamshin vamshin Jul 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To me its not coming out clear from messaging side. Should we say something like

  • New/Modify Existing APIs. API changes companion pull request created.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I propose to keep it consistent with other repos (x20 PRs), this is the language that was chosen in core.

@dblock
Copy link
Member Author

dblock commented Jul 11, 2024

@owaiskazi19 can we merge?

@owaiskazi19 owaiskazi19 merged commit 5ec5bd1 into opensearch-project:main Jul 22, 2024
15 of 20 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 22, 2024
…cklist. (#1262)

Signed-off-by: dblock <dblock@amazon.com>
(cherry picked from commit 5ec5bd1)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
jackiehanyang pushed a commit that referenced this pull request Jul 25, 2024
…cklist. (#1262) (#1266)

(cherry picked from commit 5ec5bd1)

Signed-off-by: dblock <dblock@amazon.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@dblock dblock deleted the update-pull-request-template branch July 25, 2024 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x infra Changes to infrastructure, testing, CI/CD, pipelines, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants