Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions .github/workflows/style-guide.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
name: QuantEcon Style Guide Check

on:
issue_comment:
types: [created]

jobs:
style-check:
if: contains(github.event.comment.body, '@qe-style-check')
runs-on: ubuntu-latest
name: Process style guide check request

steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
ref: ${{ github.event.issue.pull_request && github.event.pull_request.head.ref || github.sha }}

- name: Check if user has permissions
id: check-permissions
uses: actions/github-script@v7
with:
script: |
const { data: permissions } = await github.rest.repos.getCollaboratorPermissionLevel({
owner: context.repo.owner,
repo: context.repo.repo,
username: context.payload.comment.user.login
});

const hasPermissions = ['write', 'admin', 'maintain'].includes(permissions.permission);

if (!hasPermissions) {
await github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
body: '⚠️ Sorry, only collaborators with write access can trigger style guide checks.'
});
core.setFailed('User does not have sufficient permissions');
return;
}

core.setOutput('has-permissions', 'true');

- name: React to comment
if: steps.check-permissions.outputs.has-permissions == 'true'
uses: actions/github-script@v7
with:
script: |
await github.rest.reactions.createForIssueComment({
owner: context.repo.owner,
repo: context.repo.repo,
comment_id: context.payload.comment.id,
content: 'eyes'
});

- name: Run style guide check
if: steps.check-permissions.outputs.has-permissions == 'true'
id: style-check
uses: QuantEcon/meta/.github/actions/qe-style-guide@copilot/fix-228
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
style-guide: '.github/copilot-qe-style-guide.md'
docs: 'lectures/' # Adjust this to your content directory
extensions: 'md' # Adjust file extensions as needed
openai-api-key: ${{ secrets.OPENAI_API_KEY }}
model: 'gpt-4'
max-suggestions: '20'
confidence-threshold: '0.8'
Loading