This file contains hidden or 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
| name: Auto-close PRs modifying restricted files | |
| on: | |
| pull_request: | |
| types: [opened, synchronize, reopened] | |
| jobs: | |
| check-restricted-changes: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Get list of changed files | |
| id: changed-files | |
| uses: actions/github-script@v7 | |
| with: | |
| github-token: ${{ secrets.GITHUB_TOKEN }} | |
| script: | | |
| // Get the list of changed files using GitHub API | |
| const { data: files } = await github.rest.pulls.listFiles({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| pull_number: context.payload.pull_request.number | |
| }); | |
| const changedFiles = files.map(file => file.filename); | |
| console.log('Changed files:', changedFiles); | |
| // Check for restricted patterns | |
| let restrictedMatched = false; | |
| let matchedFiles = ''; | |
| // Define restricted patterns (customize these as needed) | |
| const restrictedPatterns = [ | |
| '*.plugin.js' | |
| ]; | |
| for (const file of changedFiles) { | |
| console.log('Checking file:', file); | |
| for (const pattern of restrictedPatterns) { | |
| // Convert glob pattern to regex | |
| const regexPattern = pattern.replace(/\*/g, '.*'); | |
| const regex = new RegExp(regexPattern + '$'); | |
| if (regex.test(file)) { | |
| console.log(`File ${file} matches restricted pattern: ${pattern}`); | |
| restrictedMatched = true; | |
| matchedFiles += `- ${file} (matches pattern: ${pattern})\n`; | |
| break; | |
| } | |
| } | |
| } | |
| // Set outputs | |
| core.setOutput('restricted_matched', restrictedMatched.toString()); | |
| core.setOutput('matched_files', matchedFiles); | |
| - name: Close PR if restricted files are modified | |
| if: steps.changed-files.outputs.restricted_matched == 'true' | |
| uses: actions/github-script@v7 | |
| with: | |
| github-token: ${{ secrets.GITHUB_TOKEN }} | |
| script: | | |
| const pr = context.payload.pull_request; | |
| const author = pr.user.login; | |
| const restrictedMatched = '${{ steps.changed-files.outputs.restricted_matched }}' === 'true'; | |
| let message = '@' + author + ' This pull request has been automatically closed because it modifies restricted files.\n\n'; | |
| message += '🚫 **Restricted file patterns detected**\n\n'; | |
| message += 'The following files match restricted patterns:\n'; | |
| // Format the matched files with proper markdown backticks | |
| const matchedFiles = '${{ steps.changed-files.outputs.matched_files }}'; | |
| const formattedFiles = matchedFiles.replace(/- ([^\s]+) \(matches pattern: ([^)]+)\)/g, '- `$1` (matches pattern: `$2`)'); | |
| message += formattedFiles + '\n'; | |
| message += 'These are compiled/built plugin files that are automatically generated from source code. '; | |
| message += 'Modifying these files directly is not allowed.\n\n'; | |
| message += '## How to contribute properly:\n\n'; | |
| message += '1. 📁 Make your changes in the `src/plugins/` folder instead\n'; | |
| message += '2. 🔧 Use the build script to generate the plugin files: `bun run build`\n'; | |
| message += '3. 📤 Submit a new pull request with only the source file changes from `src/`\n'; | |
| message += '4. ❌ Do **NOT** include the generated files from `Plugins/` in your PR\n\n'; | |
| message += '## Additional resources:\n'; | |
| message += '- 📖 [Contributing Guidelines](' + context.payload.repository.html_url + '/blob/master/CONTRIBUTING.md)\n'; | |
| message += '- 🏗️ [Build Documentation](' + context.payload.repository.html_url + '/blob/master/README.md)\n\n'; | |
| message += 'Thank you for your interest in contributing! Please resubmit your PR following the guidelines above. 🙏'; | |
| // Post comment explaining the closure | |
| await github.rest.issues.createComment({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| issue_number: pr.number, | |
| body: message | |
| }); | |
| // Close the pull request | |
| await github.rest.pulls.update({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| pull_number: pr.number, | |
| state: 'closed' | |
| }); | |
| // Add helpful labels | |
| const labels = ['auto-closed', 'invalid-files', 'restricted-patterns']; | |
| try { | |
| await github.rest.issues.addLabels({ | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| issue_number: pr.number, | |
| labels: labels | |
| }); | |
| } catch (error) { | |
| console.log('Note: Could not add labels. They may not exist in the repository.'); | |
| } | |
| console.log(`Successfully closed PR #${pr.number} due to restricted file modifications`); |