Add doc for types of recipes #10
Workflow file for this run
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
name: Check for unneeded recipe updates | |
on: | |
pull_request: | |
paths: | |
- '**/reference/recipes/**/*.md' | |
jobs: | |
check_updates: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Add warning comment to pull request | |
uses: actions/github-script@v6 | |
with: | |
github-token: ${{ secrets.GITHUB_TOKEN }} | |
script: | | |
const output = ` | |
While we appreciate that you're attempting to improve the docs, please be aware that all files in the \`/reference/recipes\` directory are auto-generated by the [markdown-generator](https://github.com/openrewrite/rewrite-recipe-markdown-generator). | |
Please make changes to the recipes themselves rather than to these files. When the next release happens, these files will be updated accordingly. | |
` | |
github.rest.issues.createComment({ | |
issue_number: context.issue.number, | |
owner: context.repo.owner, | |
repo: context.repo.repo, | |
body: output | |
}) |