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

[Feature] Improve GitHub Action documentation and workflow #12979

Open
peternied opened this issue Mar 29, 2024 · 1 comment
Open

[Feature] Improve GitHub Action documentation and workflow #12979

peternied opened this issue Mar 29, 2024 · 1 comment
Labels
enhancement Enhancement or improvement to existing feature or request good first issue Good for newcomers Other

Comments

@peternied
Copy link
Member

Is your feature request related to a problem? Please describe

OpenSearch has many checks that are run on pull requests which are displayed 'below the fold' of the UX in the pull request page, this makes them easy to overlook, especially when some checks report status directly into the pull request comments.

Improving documentation and instruction on how to troubleshoot a failures would lower the burden on maintainers and help contributors unblock themselves.

Describe the solution you'd like

Lets consolidate the 'result' comments that are featured in the pull request to include checks that are required before a pull request is merged along with links to documentation that describe what these checks are and how to troubleshoot.

Related component

Other

Describe alternatives you've considered

This could also be a new markdown document under .github/workflow that includes details about what each workflow is and how that are used that would be referenced in the project.

Additional context

No response

@peternied peternied added enhancement Enhancement or improvement to existing feature or request good first issue Good for newcomers untriaged labels Mar 29, 2024
@github-actions github-actions bot added the Other label Mar 29, 2024
@peternied
Copy link
Member Author

[Triage - attendees 1 2 3 4 5 6 7 8]
@peternied Thanks for creating this issue.

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
Projects
None yet
Development

No branches or pull requests

1 participant