Grout
Grout is a suite of build utilities developed by Apadmi to streamline mobile application development, release management, and CI/CD workflows for Android and iOS projects.
It provides powerful tools for automating release notes, managing task board tickets (Jira and Azure DevOps), and handling build artifacts within the Fastlane ecosystem.
📖 Documentation
The full documentation is the source of truth for Grout. It includes detailed guides on installation, architecture, and advanced usage.
✨ Key Features
- 📝 Automated Release Notes: Generate consistent, professional release notes from your commit history and task board.
- 🎟️ Task Board Integration: Seamlessly interact with Jira and Azure DevOps (ADO) to find, move, and update tickets based on build status.
- 📦 Build Artifact Management: Standardized utilities for building and naming APKs, AABs, and IPAs.
- ⚙️ Fastlane First: Designed primarily as a Fastlane plugin to drop into existing mobile CI/CD pipelines.
- 🛠️ Extensible Core: A standalone Ruby core library for users who need custom integrations outside of Fastlane.
🏗️ Architecture
Grout is split into two main components:
- Core Library (
apadmi_grout): The engine that handles API interactions with Jira/ADO, parsing logic, and model management. - Fastlane Plugin (
fastlane-plugin-apadmi_grout): A wrapper that exposes Grout's functionality as easy-to-use Fastlane actions.
🚀 Quick Start
For Fastlane Users
Add the plugin to your Pluginfile or Gemfile:
gem 'fastlane-plugin-apadmi_grout'
Then, configure your environment variables (Jira/ADO credentials, board settings) in your .env file. See the Installation Guide for details.
For Ruby Users (Core Only)
If you need the underlying logic without Fastlane dependencies:
gem 'apadmi_grout'
🤝 Contributing
We welcome contributions! Please see our Contributing Guide for information on how to get started, our architecture, and deployment processes.
📄 License
This project is licensed under the MIT License.