Skip to content

Add documentation for GitHub Action issue-comment.yml #54

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

Closed
bhouston opened this issue Mar 12, 2025 · 0 comments · Fixed by #55
Closed

Add documentation for GitHub Action issue-comment.yml #54

bhouston opened this issue Mar 12, 2025 · 0 comments · Fixed by #55

Comments

@bhouston
Copy link
Member

Add documentation for GitHub Action issue-comment.yml

We need to create a new page in the Usage documentation section that explains how to use the GitHub Action issue-comment.yml from the mycoder project. This action allows users to trigger mycoder to run via comments on issues or PRs.

Documentation should cover:

  • How the GitHub Action works
  • Benefits of using mycoder via issue/PR comments
  • Best practices for setup:
    • Using a Personal Access Token instead of the built-in GitHub Token
    • Running with userPrompt = false
    • Git configuration for commits
    • Security considerations for restricting execution to trusted individuals
  • Example usage and configuration

Location

The new documentation should be added to the /docs/usage/ directory as a new markdown file.

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 a pull request may close this issue.

1 participant