Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test: Hackathon 24 - add PatPatBot action #294

Draft
wants to merge 8 commits into
base: master
Choose a base branch
from
Draft

Conversation

nicklem
Copy link

@nicklem nicklem commented May 23, 2024

Testing the PatPatBot action in the scope of the 2024 hackathon.

@nicklem nicklem self-assigned this May 23, 2024
@nicklem nicklem force-pushed the test/patpatbot branch 4 times, most recently from 96f5a62 to 2f07e43 Compare May 23, 2024 15:26
Copy link

Adds PatPatBot Action to Review Pattern Documentation

This pull request introduces a new workflow for reviewing pattern documentation using PatPatBot.

  • Triggers the workflow on pull requests to the master branch
  • Runs on the latest Ubuntu version
  • Checks out the repository
  • Executes the PatPatBot Action using the OpenAI API key from the secrets
  • Commits automated pattern documentation updates

The changes enhance the automation of pattern documentation reviews, leveraging the PatPatBot Action and OpenAI API.


---

*This comment was generated by an experimental AI tool.*
<!-- 2a76fd44-77fb-41a7-8d35-78322a76efa5 -->

uses: actions/checkout@v2

- name: Run PatPatBot Action
uses: nicklem/patpatbot@main
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not all tools have docs/ files versioned in the repo, for example Semgrep. they will only run the documentation generation process during the build process.
it could be more versatile to have patpatbot as a CLI that we could plug-in after the documentation generation, regardless of where it happens.

"parameters": [],
"languages": [],
"enabled": false,
"title": "Enforcing Return Type Hints in CakePHP Classes",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you don't need these properties on patterns.json.
adding them to description.json is enough 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants