Skip to content

Commit 09347e4

Browse files
author
Auto-Co AI
committed
Add example workflows and issue template for repo suggestions
1 parent 5808f0e commit 09347e4

4 files changed

Lines changed: 79 additions & 0 deletions

File tree

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Suggest a Repo for DocuCraft
2+
description: Recommend a repository that should use DocuCraft for better PR descriptions
3+
labels: ["suggestion"]
4+
body:
5+
- type: input
6+
id: repo-url
7+
attributes:
8+
label: Repository URL
9+
description: The GitHub repository URL
10+
placeholder: https://github.com/owner/repo
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: reason
15+
attributes:
16+
label: Why would this repo benefit from DocuCraft?
17+
description: Briefly describe the PR quality issue you've noticed
18+
placeholder: Many PRs have empty or minimal descriptions...
19+
validations:
20+
required: false

.github/workflows/docucraft.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: DocuCraft
2+
on:
3+
pull_request:
4+
types: [opened, synchronize]
5+
permissions:
6+
contents: read
7+
pull-requests: write
8+
jobs:
9+
generate:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
- uses: CreativeCodingSolutions/docucraft@v1
14+
with:
15+
github-token: ${{ secrets.GITHUB_TOKEN }}

examples/ai-mode.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: DocuCraft AI
2+
on:
3+
pull_request:
4+
types: [opened, synchronize]
5+
permissions:
6+
contents: read
7+
pull-requests: write
8+
jobs:
9+
generate:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
- uses: CreativeCodingSolutions/docucraft@v1
14+
with:
15+
github-token: ${{ secrets.GITHUB_TOKEN }}
16+
mode: ai
17+
openai-api-key: ${{ secrets.OPENAI_API_KEY }}

examples/with-changelog.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: DocuCraft + Changelog
2+
on:
3+
pull_request:
4+
types: [opened, synchronize, closed]
5+
permissions:
6+
contents: write
7+
pull-requests: write
8+
jobs:
9+
generate:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
- uses: CreativeCodingSolutions/docucraft@v1
14+
with:
15+
github-token: ${{ secrets.GITHUB_TOKEN }}
16+
generate-changelog: true
17+
auto-label: true
18+
- name: Update Changelog
19+
if: ${{ steps.docucraft.outputs.changelog-entry != '' }}
20+
shell: bash
21+
run: |
22+
echo "${{ steps.docucraft.outputs.changelog-entry }}" >> CHANGELOG.md
23+
git config user.name "docucraft"
24+
git config user.email "actions@github.com"
25+
git add CHANGELOG.md
26+
git commit -m "Update changelog [skip ci]"
27+
git push

0 commit comments

Comments
 (0)