GitAuto: [FEATURE] Add `ChangeRunner` command

gitauto-ai[bot] commented 1 month ago

Resolves #76

What is the feature

Implement a new bot command changeRunner that modifies the runner specified in GitHub Actions workflow files. This command allows users to change the runs-on property for a specific job, a list of jobs, or all jobs within a workflow file, streamlining the process of updating runners across workflows.

Why we need the feature

Manually updating the runner for multiple jobs or workflows can be time-consuming and error-prone, especially in large projects with complex CI/CD pipelines. By introducing the changeRunner command, we automate this process, improving developer productivity and ensuring consistency across the project's workflows. This feature simplifies maintenance and allows for quick adaptations to changes in runner environments or infrastructure.

How to implement and why

Implementation Steps:

Command Parsing
- Extract Command Parameters: Implement a parser to extract the <new_runner_name> and [job_name|job_list|all] from the command input.
- Validate Inputs: Ensure that the new runner name is valid and the specified job names exist in the workflow file. Provide clear error messages for invalid inputs.
Workflow File Retrieval
- Access Workflow Files: Use the GitHub REST API to retrieve the content of the .github/workflows/<workflow_file>.yml.
- Handle Multiple Workflows: If necessary, determine which workflow files need modification based on the context or extend the command to specify workflow files.
Modify the Workflow Content
- Parse YAML Content: Use a YAML parser to read the workflow file content safely.
- Update runs-on Properties:
  - If specific jobs are specified, locate those jobs and update their runs-on properties.
  - If all is specified or no jobs are provided, update the runs-on property for all jobs in the workflow.
- Preserve File Integrity: Ensure that the modification does not alter other parts of the workflow file.
Commit Changes
- Prepare Commit Data: Encode the updated workflow content and prepare a commit message detailing the changes.
- Use GitHub API for Commit: Commit the changes back to the repository using the GitHub REST API, possibly creating a new branch or pull request if appropriate.
- Handle Concurrency: Manage potential conflicts if the workflow file has been changed since it was retrieved.
Provide Feedback
- Success Message: Inform the user that the runner has been successfully updated for the specified jobs.
- Error Handling: If errors occur, such as invalid job names or missing workflow files, provide clear and actionable error messages.

Reasons:

Automated Updates: Reduces manual effort and minimizes human errors during runner updates.
Flexibility: Allows targeted updates to specific jobs or bulk updates to all jobs, accommodating various use cases.
Maintainability: Using a modular approach with clear steps makes the code easier to maintain and extend in the future.
User Experience: Providing immediate feedback improves the interaction with the bot and enhances user satisfaction.

About backward compatibility

This feature is backward compatible as it introduces a new command without affecting existing functionalities. The default behavior of the bot remains unchanged unless the changeRunner command is explicitly invoked. Existing workflows and jobs will continue to operate as before unless modified using this new command. By ensuring that no existing commands or processes are altered, we maintain stability and prevent disruptions to current CI/CD operations.

Test these changes locally

git checkout -b gitauto/issue-#76-04c5c60a-4efd-4423-8bec-70b45f02cdac
git pull origin gitauto/issue-#76-04c5c60a-4efd-4423-8bec-70b45f02cdac

deepsource-io[bot] commented 1 month ago

Here's the code health analysis summary for commits 7f7cf9e..d73aec0. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Link
Docker	✅ Success	View Check ↗
PHP	✅ Success	View Check ↗
Secrets	✅ Success	View Check ↗
SQL	✅ Success	View Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

coderabbitai[bot] commented 2 weeks ago

[!IMPORTANT]

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.