Skip to content

Conversation

@umaarov
Copy link
Contributor

@umaarov umaarov commented Aug 28, 2025

This PR creates a new troubleshooting guide to help new contributors understand and fix common CI/CD failures, as requested in issue #12979.

What's included:

  • A new guide at .github/WORKFLOW_TROUBLESHOOTING.md that covers DCO, Changelog, Gradle, and Backport checks.
  • An entry in CHANGELOG.md for this change.

Closes #12979

Signed-off-by: Umarov Ismoiljon <hs.umarov21@gmail.com>
@umaarov umaarov requested review from a team, jed326 and peternied as code owners August 28, 2025 17:26
@github-actions github-actions bot added enhancement Enhancement or improvement to existing feature or request good first issue Good for newcomers Other labels Aug 28, 2025
@andrross
Copy link
Member

I'm more inclined to make things self-documenting rather than add text to a markdown file that a contributor may or may not be able to find. For example, the DCO workflow is clickable, and the resulting page gives a link that says View more details on DCO. In case of a DCO failure it provides detailed instructions about how to fix your commit. I'm not sure it's helpful to duplicate that information in other places.

For the other workflows, I'd love to see if we can find ways to provide the same basic experience: I see a failed workflow in my PR, I click on the workflow link, I get details about what the failure means that allows me to understand it and fix it.

Signed-off-by: Umarov Ismoiljon <hs.umarov21@gmail.com>
@umaarov umaarov force-pushed the docs-troubleshooting-guide-12979 branch from d53cebd to 50674f3 Compare August 29, 2025 06:21
@umaarov
Copy link
Contributor Author

umaarov commented Sep 4, 2025

Hi @andrross @peternied,
Just wanted to follow up gently on this PR. I updated it last week based on the feedback and was hoping to get the workflow runs approved when you have a moment. Thanks again for your time and guidance!

Co-authored-by: Andrew Ross <andrross@amazon.com>
Signed-off-by: Umarov Ismoiljon <hs.umarov21@gmail.com>
@andrross andrross changed the title docs: Create a troubleshooting guide for CI checks (#12979) Add detailed message to changelog workflow (#12979) Sep 9, 2025
@andrross andrross merged commit cd9d138 into opensearch-project:main Sep 9, 2025
33 of 34 checks passed
jainankitk pushed a commit to jainankitk/OpenSearch that referenced this pull request Sep 22, 2025
Signed-off-by: Umarov Ismoiljon <hs.umarov21@gmail.com>
Co-authored-by: Andrew Ross <andrross@amazon.com>
jainankitk pushed a commit to jainankitk/OpenSearch that referenced this pull request Sep 22, 2025
Signed-off-by: Umarov Ismoiljon <hs.umarov21@gmail.com>
Co-authored-by: Andrew Ross <andrross@amazon.com>
Signed-off-by: Ankit Jain <jainankitk@apache.org>
jainankitk pushed a commit to jainankitk/OpenSearch that referenced this pull request Sep 22, 2025
Signed-off-by: Umarov Ismoiljon <hs.umarov21@gmail.com>
Co-authored-by: Andrew Ross <andrross@amazon.com>
Signed-off-by: Ankit Jain <jainankitk@apache.org>
asimmahmood1 pushed a commit to jainankitk/OpenSearch that referenced this pull request Sep 23, 2025
Signed-off-by: Umarov Ismoiljon <hs.umarov21@gmail.com>
Co-authored-by: Andrew Ross <andrross@amazon.com>
pranikum pushed a commit to pranikum/OpenSearch that referenced this pull request Sep 23, 2025
Signed-off-by: Umarov Ismoiljon <hs.umarov21@gmail.com>
Co-authored-by: Andrew Ross <andrross@amazon.com>
vinaykpud pushed a commit to vinaykpud/OpenSearch that referenced this pull request Sep 26, 2025
Signed-off-by: Umarov Ismoiljon <hs.umarov21@gmail.com>
Co-authored-by: Andrew Ross <andrross@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement Enhancement or improvement to existing feature or request good first issue Good for newcomers Other skip-changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature] Improve GitHub Action documentation and workflow

2 participants