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

[CI] Create doc issue workflow #1515

Merged
merged 2 commits into from
Apr 29, 2022

Conversation

kavilla
Copy link
Member

@kavilla kavilla commented Apr 28, 2022

Description

Add workflow to create documentation issue in
https://github.com/opensearch-project/documentation-website

Update CONTRIBUTING doc on how to use.

Signed-off-by: Kawika Avilla kavilla414@gmail.com

Issues Resolved

#1493

Check List

  • New functionality includes testing.
    • All tests pass
      • yarn test:jest
      • yarn test:jest_integration
      • yarn test:ftr
  • New functionality has been documented.
  • Commits are signed per the DCO using --signoff

Add workflow to create documentation issue in
https://github.com/opensearch-project/documentation-website

Update CONTRIBUTING doc on how to use.

Issue:
opensearch-project#1493

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>
@kavilla kavilla requested a review from a team as a code owner April 28, 2022 21:48
@kavilla kavilla added the v3.0.0 label Apr 28, 2022
@kavilla kavilla linked an issue Apr 28, 2022 that may be closed by this pull request
@kavilla kavilla requested a review from VachaShah April 28, 2022 21:48
@kavilla
Copy link
Member Author

kavilla commented Apr 28, 2022

@VachaShah, does https://github.com/opensearch-project/OpenSearch/blob/main/.github/workflows/create-documentation-issue.yml#L28 work? I pulled the checkout step and echo to markdown step and without providing the . before github it failed so I'd imagine it'd be the same for .ci

@codecov-commenter
Copy link

codecov-commenter commented Apr 28, 2022

Codecov Report

Merging #1515 (5198a0b) into main (f9e572d) will decrease coverage by 0.00%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1515      +/-   ##
==========================================
- Coverage   68.09%   68.09%   -0.01%     
==========================================
  Files        3072     3072              
  Lines       59032    59032              
  Branches     8928     8928              
==========================================
- Hits        40200    40198       -2     
- Misses      16646    16647       +1     
- Partials     2186     2187       +1     
Impacted Files Coverage Δ
...ic/application/models/sense_editor/sense_editor.ts 64.00% <0.00%> (-0.89%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f9e572d...5198a0b. Read the comment docs.

CONTRIBUTING.md Outdated Show resolved Hide resolved
Signed-off-by: Kawika Avilla <kavilla414@gmail.com>
@kavilla kavilla requested a review from ashwin-pc April 29, 2022 00:59
@kavilla kavilla added the ci label Apr 29, 2022
@ashwin-pc
Copy link
Member

Nice!

Copy link
Member

@ananzh ananzh left a comment

Choose a reason for hiding this comment

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

❤️

@ashwin-pc ashwin-pc merged commit 18b8a09 into opensearch-project:main Apr 29, 2022
@joshuarrrr
Copy link
Member

How does this work in the case where a contributor creates a parallel documentation PR at the same time? Maintainers just skip adding the label, because the issue isn't needed?

pjfitzgibbons pushed a commit to pjfitzgibbons/OpenSearch-Dashboards that referenced this pull request Aug 10, 2022
* [CI] Create doc issue workflow

Add workflow to create documentation issue in
https://github.com/opensearch-project/documentation-website

Update CONTRIBUTING doc on how to use.

Issue:
opensearch-project#1493

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>

* follow up

Signed-off-by: Kawika Avilla <kavilla414@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a workflow for documenting features
5 participants