-
Notifications
You must be signed in to change notification settings - Fork 113
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds workflow to create documentation issues (#358)
* Adds documentation issue workflow Signed-off-by: Clay Downs <[email protected]> * Makes the issue template more relevant Signed-off-by: Clay Downs <[email protected]>
- Loading branch information
Showing
2 changed files
with
52 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
**Is your feature request related to a problem?** | ||
A new feature has been added. | ||
|
||
**What solution would you like?** | ||
Document the usage of the new feature. | ||
|
||
**What alternatives have you considered?** | ||
N/A | ||
|
||
**Do you have any additional context?** | ||
_Add any other context or screenshots about the feature request here._ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
name: Create Documentation Issue | ||
on: | ||
pull_request: | ||
types: | ||
- labeled | ||
env: | ||
PR_NUMBER: ${{ github.event.number }} | ||
|
||
jobs: | ||
create-issue: | ||
if: ${{ github.event.label.name == 'needs-documentation' }} | ||
runs-on: ubuntu-latest | ||
name: Create Documentation Issue | ||
steps: | ||
- name: GitHub App token | ||
id: github_app_token | ||
uses: tibdex/[email protected] | ||
with: | ||
app_id: ${{ secrets.APP_ID }} | ||
private_key: ${{ secrets.APP_PRIVATE_KEY }} | ||
installation_id: 22958780 | ||
|
||
- name: Checkout code | ||
uses: actions/checkout@v2 | ||
|
||
- name: Edit the issue template | ||
run: | | ||
echo "https://github.com/opensearch-project/index-management/pull/${{ env.PR_NUMBER }}." >> ./.github/ISSUE_TEMPLATE/documentation.md | ||
- name: Create Issue From File | ||
id: create-issue | ||
uses: peter-evans/create-issue-from-file@v4 | ||
with: | ||
title: Add documentation related to new feature | ||
content-filepath: ./.github/ISSUE_TEMPLATE/documentation.md | ||
labels: documentation | ||
repository: opensearch-project/documentation-website | ||
token: ${{ steps.github_app_token.outputs.token }} | ||
|
||
- name: Print Issue | ||
run: echo Created related documentation issue ${{ steps.create-issue.outputs.issue-number }} |