Adding workflow for creating documentation issues #1857
Conversation
Signed-off-by: Vacha Shah <vachshah@amazon.com>
VachaShah
force-pushed
the
documentation-issue-workflow
branch
from
852dae7
to
554dd0c
Compare
Codecov Report
@@ Coverage Diff @@
## main #1857 +/- ##
=========================================
Coverage 60.86% 60.86%
- Complexity 3212 3213 +1
=========================================
Files 256 256
Lines 18006 18006
Branches 3209 3209
=========================================
Hits 10959 10959
Misses 5467 5467
Partials 1580 1580 Continue to review full report at Codecov.
|
| N/A | ||
|
|
||
| **Do you have any additional context?** | ||
| See please |
There was a problem hiding this comment.
Not sure what the context should be for this, could you update?
There was a problem hiding this comment.
So when the workflow runs, the PR number will be appended here (line).
There was a problem hiding this comment.
@hdhalter and I worked on together on a Docs specific issue template. I've added our initial draft here:
What do you want to do?
- Request a change to existing documentation
- Add new documentation
- Report a technical problem with the documentation
- Other
Tell us about your request. For example, what feature or area does it affect? What versions? If it’s a change to existing documentation, which pages (URLs) are affected?
Do you have any related resources to help us get started (e.g., link to a related fixed issue, design doc, etc.)? Any particular POCs (Eng or PM) who have more information?
Is there anything else you'd like to add?
There was a problem hiding this comment.
This is a great step forward in making sure we've got documentation in our projects, thanks for taking the time Vacha. I think there are some issues related to the overall workflow of these automatically generated pull requests, please see the comments I've added.
| @@ -0,0 +1,11 @@ | |||
| **Is your feature request related to a problem?** | |||
There was a problem hiding this comment.
This format doesn't seem very useful, could we re-write to provide the needed details for the documentation team, is the following all we need?
### Documentation update for OpenSearch Security Plugin
An update to the documentation is needed, see the related pull request for the changes that have been introduced.
Pull request:
There was a problem hiding this comment.
Note; it might be worthwhile to see about using SED or another utility to allow env variables to be updated in the template file so the workflow can provide more information
There was a problem hiding this comment.
Yeah I had tried using that but faced some issues as far as I remember. I will try again to see how it can be made better with more information.
|
|
||
| jobs: | ||
| create-issue: | ||
| if: ${{ github.event.label.name == 'needs-documentation' }} |
There was a problem hiding this comment.
How do we avoid accidently adding this label on backports or other issues that won't make sense?
Maybe tag the user that applied the label in the new documentation issue or do you have thoughts on other mechanism to ensure good ownership after its been created?
There was a problem hiding this comment.
Let me see if we can assign the documentation issue to the contributor who created the PR. WDYT about that?
| id: create-issue | ||
| uses: peter-evans/create-issue-from-file@v4 | ||
| with: | ||
| title: Add documentation related to new feature |
There was a problem hiding this comment.
Could we make this title more useful? otherwise the doc repos issues are going to be a mess to navigate with lots of the same title
There was a problem hiding this comment.
Sure, I will improve the template with better information.
|
Closing this PR till the workflow steps are finalized. |
Signed-off-by: Vacha Shah vachshah@amazon.com
Description
Adding workflow to automatically create issues in
documentation-websiterepo when aneeds-documentationlabel is added to a PR.Issues Resolved
#1786
Is this a backport? If so, please add backport PR # and/or commits #
Testing
[Please provide details of testing done: unit testing, integration testing and manual testing]
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.