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

📝 Document commit-monitor action in README.md #9

Merged
merged 3 commits into from
Apr 14, 2024

Conversation

arcane-engine[bot]
Copy link
Contributor

@arcane-engine arcane-engine bot commented Apr 14, 2024

The commit-monitor action has been documented and the updated README.md file is now available in the commit-monitor directory.

@arcane-engine arcane-engine bot added documentation Improvements or additions to documentation enhancement New feature or request pr-pilot labels Apr 14, 2024
@mlamina
Copy link
Contributor

mlamina commented Apr 14, 2024

Copy link
Contributor Author

arcane-engine bot commented Apr 14, 2024

You have used up your budget. Please visit the Dashboard to purchase more credits.

@mlamina
Copy link
Contributor

mlamina commented Apr 14, 2024

Copy link
Contributor Author

arcane-engine bot commented Apr 14, 2024

I've reviewed the commit-monitor/action.yaml and will now update the commit-monitor/README.md to include more accurate information about the parameters and some potential usage examples.

Updated commit-monitor/README.md:

# Commit-Monitor Action

The `commit-monitor` action is designed to enhance your workflow by allowing you to define specific keywords or commands (e.g., `/task`) within your commit messages. When these are detected, the action can automatically delegate follow-up work, such as creating issues, triggering other workflows, or notifying team members. This feature is particularly useful for automating routine tasks and ensuring that important follow-up actions are not overlooked in the development process.

## How It Helps You

- **Automate Follow-Up Tasks:** Automatically trigger specific actions or tasks based on keywords in commit messages.
- **Improve Workflow Efficiency:** Reduce manual oversight and intervention by automating the delegation of follow-up work.
- **Enhance Collaboration:** Ensure that team members are promptly notified or assigned tasks relevant to the commit, improving team collaboration and project management.

## Usage

To use the `commit-monitor` action in your project, you'll need to include it in your GitHub workflow files. Define the keywords or commands you wish to monitor in your commit messages, and configure the action to perform the desired follow-up tasks when those keywords are detected.

### Inputs

- `sdk-version`: (Optional) Specifies the PR Pilot SDK version to use. Default is `1.0.3`.
- `api-key`: (Required) Your API key for PR Pilot.
- `trigger-keyword`: (Required) The keyword to trigger task creation.

### Example Workflow

```yaml
name: Commit Monitor Workflow
on: [push]

jobs:
  commit-monitor:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: PR-Pilot-AI/smart-actions/commit-monitor@main
      with:
        api-key: ${{ secrets.PR_PILOT_API_KEY }}
        trigger-keyword: '/task'

This example demonstrates how to set up the commit-monitor action in a GitHub workflow. Replace PR_PILOT_API_KEY with your actual PR Pilot API key and /task with the keyword you want to use for triggering tasks.

For detailed instructions on how to set up and configure the commit-monitor action, refer to the GitHub workflow documentation.


This update includes a detailed description of the inputs required for the `commit-monitor` action and a practical example of how to incorporate it into a GitHub workflow.

---
📋 **[Log](https://app.pr-pilot.ai/dashboard/tasks/585f0a95-08b6-401c-b8b6-17d9e770c131/)** ↩️ **[Undo](https://app.pr-pilot.ai/dashboard/tasks/585f0a95-08b6-401c-b8b6-17d9e770c131/undo/)**

@mlamina mlamina merged commit 977b880 into main Apr 14, 2024
1 check passed
@mlamina mlamina deleted the pr-pilot/update-readme-md-for-commit-monitor-actio branch April 14, 2024 05:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request pr-pilot
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant