apadmi_grout 3.0.1 → 3.0.2.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4775d81698b85b554101ef606f4984ebba39d4fc4605517e35704aeb83178d32
-  data.tar.gz: 231646a9c8136ed6a9a3d5d90208352ff76627cc70f5f6b3fa53bddfb9944bf2
+  metadata.gz: 8200a36a820e413ef28ef79b76e1cecfcd602e2ff09412030e0a3b8167e361c2
+  data.tar.gz: 75fa9c3aec135ee840a555444f388fda7f62dc04ab99bee558e4bf8651ccd46a
 SHA512:
-  metadata.gz: a86582dc2fa4072e16037a8f0f63ff1c728e8896bc89f94032bfe7a2de6a7087800f5c2139d958a758e1ed063859bd4f3e3a64f0471fe94166f4766bf17c43af
-  data.tar.gz: 5f52f4496409c7517250e7f0aa8688262f3f5cf52fa40612531af2ac929250efc6a96da8353091b0d60b014d2cb98cd0059b62f9f3aa99e2f5dc613203f10cf5
+  metadata.gz: a58473dc58f546c38d67807298c863a6ed3c990e5cd1b0fcfe760280ed2e261890ae9548bf619569a5ab387d03aaacd1a029dba94732ec0fd89c8e0197aaa8b7
+  data.tar.gz: a7f4964a80e63b2982655f3f68eee8b4cab1c0c21a31fd1d3048fbf65118f301b274249f6cf53c20d73e4a2ebab68fbd95dc4c01ac4e6555c7e69936b260f105

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Apadmi Ltd
+Copyright (c) 2026 Apadmi Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,3 +1,62 @@
-# Apadmi::Grout
+# Grout
 
-See documentation here: https://apadmi-grout.web.app/
+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.
+
+👉 **[View the full documentation](https://apadmi-grout.web.app/)**
+
+---
+
+## ✨ 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:
+
+1.  **Core Library (`apadmi_grout`):** The engine that handles API interactions with Jira/ADO, parsing logic, and model management.
+2.  **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`:
+
+```ruby
+gem 'fastlane-plugin-apadmi_grout'
+```
+
+Then, configure your environment variables (Jira/ADO credentials, board settings) in your `.env` file. See the [Installation Guide](https://apadmi-grout.web.app/usage/installation) for details.
+
+### For Ruby Users (Core Only)
+
+If you need the underlying logic without Fastlane dependencies:
+
+```ruby
+gem 'apadmi_grout'
+```
+
+---
+
+## 🤝 Contributing
+
+We welcome contributions! Please see our [Contributing Guide](https://apadmi-grout.web.app/contributing/getting-started) for information on how to get started, our architecture, and deployment processes.
+
+## 📄 License
+
+This project is licensed under the [MIT License](LICENSE).

data/lib/apadmi/grout/actions/issues_from_changelog_action.rb

@@ -5,7 +5,7 @@ module Apadmi
     # Finds and returns a list of all the issues who's ids exist in the given changelog
     class IssuesFromChangelogAction
       # @param board_service [Apadmi::Grout::BoardService]
-      # @param ticket_prefix [String] The prefix for the ticket numbers in git e.g "PPT-"
+      # @param ticket_prefix [String] The prefix for the ticket numbers in git e.g "GROUT-"
       # @param [Apadmi::Grout::DefaultLogger] // or your own logger!
       def initialize(board_service, ticket_prefix, logger)
         @board_service = board_service

data/lib/apadmi/grout/models/issue.rb

@@ -12,7 +12,7 @@ module Apadmi
     #   nil for unclassified fallback issues created from commit messages when the ticket was not found.
     Issue = Struct.new(:key, :summary, :status, :issue_type, :url, :raw_object) do
       # Creates a fallback issue from a commit message when the ticket ID could not be found in the board.
-      # @param key [String] the ticket ID as extracted from the commit (e.g. "PPT-999")
+      # @param key [String] the ticket ID as extracted from the commit (e.g. "GROUT-999")
       # @param summary [String] the first line of the commit message
       # @return [Apadmi::Grout::Issue]
       def self.unclassified(key, summary)

data/lib/apadmi/grout/service/board_service/jira_board_service.rb

@@ -63,6 +63,7 @@ module Apadmi
         end
 
         transitions = @jira_client.Transition.all(issue: issue.raw_object)
+
         transition = transitions.find { |elem| elem.name.downcase == state_name.downcase }
 
         trans = issue.raw_object.transitions.build

data/lib/apadmi/grout/version.rb

@@ -2,6 +2,6 @@
 
 module Apadmi
   module Grout
-    VERSION = "3.0.1"
+    VERSION = "3.0.2.pre"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apadmi_grout
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2.pre
 platform: ruby
 authors:
 - Apadmi