Introducing Bosun
Welcome to Bosun! This documentation will guide you through leveraging Bosun to automate and streamline your development workflows. At the heart of Bosun are tasks – intelligent, automated, repeatable workflows to kick-start your maintenance journey.
Why Bosun?
The pace of incredible innovation in AI assisted coding tools is staggering. Bosun does not focus on assisted coding or code generation. Instead, Bosun enables the creation of repeatable, automated workflows.
Want to migrate your flask app to FastAPI? Want to add logging to all your functions? Want to add unit tests for all your public methods? Bosun can help you do that. And more importantly, you can work on the creative, high-value parts of your project while Bosun takes care of the repetitive, time-consuming tasks.
What are Bosun Tasks?
Bosun tasks are pre-built or custom-defined sequences of actions that operate directly on your code. Think of them as your automated "code-mates" that can perform a wide range of operations, such as:
- Refactoring code: Modernizing, improving, or restructuring code.
- Migrating legacy code: Updating old codebases to use new libraries, frameworks, or coding standards.
- Fixing common issues: Addressing linting errors, security vulnerabilities, or performance bottlenecks.
- Generating tests: Creating unit, integration, or end-to-end tests for new or existing code.
- Updating documentation: Ensuring your project's documentation is always current and accurate.
- Migrating dependencies: Upgrading libraries or frameworks across your entire codebase.
Tailoring and Customizing Your Workflows
Bosun tasks are designed to be highly flexible and adaptable to your specific project needs:
- Repeatability: Once defined, tasks can be executed multiple times across different branches, repositories, or parts of your code.
- Configuration: Each task comes with configurable parameters, allowing you to define its scope, behavior, and specific targets within your repository.
- Customization: For more advanced scenarios, you can extend existing tasks or create entirely new ones using a straightforward definition language. This allows you to build bespoke automation that perfectly matches your team's conventions and requirements.
- Integration: Bosun integrates seamlessly into your existing CI/CD pipelines, triggering tasks based on events like new commits, pull requests, or scheduled intervals.
By understanding and utilizing Bosun tasks, you can offload repetitive and time-consuming development work, allowing your team to focus on innovation and delivering value faster. Let's dive in!