The GitHub Automator is a Rust-based tool designed to streamline and automate common Git operations on GitHub repositories. Whether you're adding, committing, and pushing changes, generating commit messages, or managing pull requests, this tool simplifies the process, saving you time and effort.
- Automated Git Operations: Perform common Git operations, such as adding files, committing changes, and pushing commits, with ease and efficiency.
- Commit Message Generation: Generate meaningful commit messages automatically, eliminating the need for manual entry and ensuring consistency across commits.
- GitHub Integration: Seamlessly integrate with GitHub repositories, enabling smooth interaction with remote repositories and pull requests.
- Customization Options: Tailor the tool to your needs with customizable settings for commit message generation, branch management, and more.
- User-Friendly Interface: Enjoy a user-friendly command-line interface that makes Git operations intuitive and accessible.
The GitHub Automator utilizes Rust's robust libraries to interact with Git and GitHub. Here’s a high-level overview of its workflow:
- Initialization: The tool initializes a Git repository (if not already initialized) and sets the remote origin based on the provided repository link.
- Adding Changes: It stages all changes in the repository using the git add -A command.
- Status Check: The tool executes git status to display the current status of the repository, ensuring all changes are staged correctly.
- Commit Changes: A commit is made with an automatically generated commit message using a names generator.
- Push Changes: Finally, the tool pushes the committed changes to the specified branch (defaulting to master if no branch is specified).
- Install the Tool:
cargo install git_automate
- Add to Your Project:
cargo add git_automate
- Configure Your Setup: Set up with your GitHub credentials and repository info.
- Automate Your Workflow: Use the command-line interface to streamline your Git operations.
--link
or-l
: The URL of the GitHub repository. This sets the remote origin if not already set.--branch
or-b
: The branch name to push to. If not specified, defaults tomaster
.--help
or-h
: Displays this help message and exits. Use this option to get information about the available command-line arguments and their usage.
Contributions to the GitHub Automator are welcome! If you encounter any bugs, have feature requests, or want to contribute code improvements, feel free to open an issue or submit a pull request on the project's GitHub repository.
Before contributing, please review the project's contribution guidelines and code of conduct to ensure a positive and collaborative community environment.
The GitHub Automator is open-source software licensed under the MIT License. You are free to use, modify, and distribute the tool for any purpose, subject to the terms of the license.