Installation
Fastlane Users
Most users will interact with the Grout utils through Fastlane.
Add the following to your Gemfile
gem 'fastlane-plugin-apadmi_grout', '~> 2.7.0'
Note
The core library referenced in part of these docs is already a dependency of the fastlane plugin
so there shouldn't be a need to add it to your Gemfile
Environment Variables
Create a .env
file within the fastlane
directory of your project.
Here's an example of the file's contents
CLIENT_NAME = "Apadmi"
PRODUCT_NAME = "Grout"
BOARD_BASE_URL="https://apadmi.atlassian.net"
# This is also the prefix of the JIRA tickets. e.g. PPT-223
JIRA_PROJECT_KEY="PPT"
# The title of your release notes
RELEASE_NOTES_TITLE="Test - App (Android) - Release Notes"
# Only tickets with this component assigned on the board will be considered for moving
BOARD_COMPONENT_NAME="Android App"
# Status of tickets to be moved by the build
BOARD_STATUS_FROM="Awaiting QA Release"
# The new status to assign to tickets being moved.
BOARD_STATUS_TO="Ready For QA"
CLIENT_NAME = "Apadmi"
PRODUCT_NAME = "Grout"
BOARD_BASE_URL="https://dev.azure.com/samdc0009/apadmi-grout-testing/_apis/"
BOARD_PROVIDER="ADO"
# The title of your release notes
RELEASE_NOTES_TITLE="Test - App (Android) - Release Notes"
# Only tickets with this component assigned on the board will be considered for moving
BOARD_COMPONENT_NAME="Android App"
# Status of tickets to be moved by the build
BOARD_STATUS_FROM="Active"
# The new status to assign to tickets being moved.
BOARD_STATUS_TO="Resolved"
Important
Many of the code snippets in these docs make the assumption that these Environment variables exist.
Ignoring this step will mean needing to provide them all manually to each step.
Ensure the following additional Environment variables are accessible to your CI/CD system (or wherever you're running the scripts)
Danger
Make sure you do NOT commit these credentials to source control.
Other Users
If you're not using Fastlane then use the core directly by adding the following to your Gemfile
gem 'apadmi_grout', '~> 2.7.0'
Warning
The core library by definition doesn't include the Fastlane utils. If you need these please use fastlane.