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

add path ignore for markdown files #2312

Merged

Conversation

abbyhu2000
Copy link
Member

Signed-off-by: abbyhu2000 [email protected]

Description

To save resources and job runners, some PRs do not need to run the full test suite. For PRs and pushes with markdown changes only, the build and test workflow will be skipped. (Linter test should be okay to skipped since it will automatically run with every commit). For PRs and pushes with markdown changes along with other changes, the build and test workflow will not be skipped.

Issues Resolved

resolves #1214

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

@abbyhu2000 abbyhu2000 self-assigned this Sep 10, 2022
@codecov-commenter
Copy link

Codecov Report

Merging #2312 (0fcd7ac) into main (77af7f9) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #2312   +/-   ##
=======================================
  Coverage   66.55%   66.55%           
=======================================
  Files        3169     3169           
  Lines       60313    60313           
  Branches     9182     9182           
=======================================
  Hits        40141    40141           
  Misses      17979    17979           
  Partials     2193     2193           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@abbyhu2000 abbyhu2000 force-pushed the skip_workflow_for_markdown_change branch from 0fcd7ac to 982e239 Compare September 12, 2022 23:39
@abbyhu2000 abbyhu2000 marked this pull request as ready for review September 12, 2022 23:39
@abbyhu2000 abbyhu2000 requested a review from a team as a code owner September 12, 2022 23:39
Copy link
Member

@zhongnansu zhongnansu left a comment

Choose a reason for hiding this comment

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

  1. Should we also ignore .asciidoc file changes?
  2. How do we keep doc website updated with doc in codebase? Do we have any workflows that auto update our doc website using any of the .md files in codebase? or any ongoing documentation related projects will do that? If that's the case, CI will help to make sure doc is correct and always updated.

cc @kavilla since you created the issue.

@kavilla
Copy link
Member

kavilla commented Sep 13, 2022

  1. Should we also ignore .asciidoc file changes?

    1. How do we keep doc website updated with doc in codebase? Do we have any workflows that auto update our doc website using any of the .md files in codebase? or any ongoing documentation related projects will do that? If that's the case, CI will help to make sure doc is correct and always updated.

cc @kavilla since you created the issue.

the current doc site https://opensearch.org/docs/latest/dashboards/index/ actually only hosts manually updates from the doc team in the doc repo.

unofficially we use https://cptnb.github.io/opensearch-dashboards-dev-docs/ to host dev docs (docs from this repo), which I believe @CPTNB has a fork of the repo that has a workflow that publishes dev docs there.

for the .asciidoc, it's probably good feature to add the future.

@kavilla kavilla merged commit ab99eac into opensearch-project:main Sep 14, 2022
opensearch-trigger-bot bot pushed a commit that referenced this pull request Sep 14, 2022
To save resources and job runners, some PRs do not need to run the full test suite. For PRs and pushes with markdown changes only, the build and test workflow will be skipped. (Linter test should be okay to skipped since it will automatically run with every commit). For PRs and pushes with markdown changes along with other changes, the build and test workflow will not be skipped.

Issue Resolved:
#1214

Signed-off-by: abbyhu2000 <[email protected]>
(cherry picked from commit ab99eac)
sipopo pushed a commit to sipopo/OpenSearch-Dashboards that referenced this pull request Sep 14, 2022
To save resources and job runners, some PRs do not need to run the full test suite. For PRs and pushes with markdown changes only, the build and test workflow will be skipped. (Linter test should be okay to skipped since it will automatically run with every commit). For PRs and pushes with markdown changes along with other changes, the build and test workflow will not be skipped.

Issue Resolved:
opensearch-project#1214

Signed-off-by: abbyhu2000 <[email protected]>
Signed-off-by: Sergey V. Osipov <[email protected]>
kavilla pushed a commit that referenced this pull request Sep 15, 2022
To save resources and job runners, some PRs do not need to run the full test suite. For PRs and pushes with markdown changes only, the build and test workflow will be skipped. (Linter test should be okay to skipped since it will automatically run with every commit). For PRs and pushes with markdown changes along with other changes, the build and test workflow will not be skipped.

Issue Resolved:
#1214

Signed-off-by: abbyhu2000 <[email protected]>
(cherry picked from commit ab99eac)

Co-authored-by: Qingyang(Abby) Hu <[email protected]>
@AMoo-Miki AMoo-Miki added the v2.4.0 'Issues and PRs related to version v2.4.0' label Nov 5, 2022
sipopo pushed a commit to sipopo/OpenSearch-Dashboards that referenced this pull request Dec 16, 2022
To save resources and job runners, some PRs do not need to run the full test suite. For PRs and pushes with markdown changes only, the build and test workflow will be skipped. (Linter test should be okay to skipped since it will automatically run with every commit). For PRs and pushes with markdown changes along with other changes, the build and test workflow will not be skipped.

Issue Resolved:
opensearch-project#1214

Signed-off-by: abbyhu2000 <[email protected]>
Signed-off-by: Sergey V. Osipov <[email protected]>
@abbyhu2000 abbyhu2000 deleted the skip_workflow_for_markdown_change branch June 30, 2023 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x ci v2.4.0 'Issues and PRs related to version v2.4.0'
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Git] Do not run full build-test workflow on markdown only changes
6 participants