Fastlane is a popular open-source toolset designed to automate the process of building, testing, and releasing mobile apps for iOS and Android platforms. It helps streamline various tasks such as building, code signing, testing, deploying, and releasing apps, reducing the manual effort required for these tasks and improving the overall development workflow.
Fastlane provides a collection of tools and actions that can be configured and combined to create custom workflows tailored to specific project requirements. Some of the key features and capabilities of Fastlane include:
## What is this repo
This repo is a reference repo for native Android project with fastlane integration. This repo has the required fastlane setup and the
## Getting started
## Fastlane setup in the project
Fastlane needs Ruby in the system, below command can be used to install Ruby in the Linux system
>> sudo apt-get install -y ruby-full
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Install Bundler using RubyGems
>> sudo gem install bundler
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
Create ./Gemfile in the project root directory with below content
source "https://rubygems.org"
gem "fastlane
## Add your files
Then Run
>> bundle update
-[ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-[ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
You'll be asked to confirm that you're ready to begin, and then for a few pieces of information. To get started quickly:
-[ ] [Set up project integrations](https://gitlab.niveussolutions.com/karthik.shetty/apkforfastlane/-/settings/integrations)
> Provide the package name for your application when asked (e.g. io.fabric.yourapp)
> Press enter when asked for the path to your json secret file
> Answer 'n' when asked if you plan on uploading info to Google Play via fastlane (we can set this up later)
## Collaborate with your team
That's it! fastlane will automatically generate a configuration for you based on the information provided.
-[ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-[ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-[ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
You can see the newly created ./fastlane directory, with the following files:
> Appfile which defines configuration information that is global to your app
> Fastfile which defines the "lanes" that drive the behavior of fastlane
## Test and Deploy
Use the built-in continuous integration in GitLab.
Appfile:
This include any credentials details or the keystore details
-[ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-[ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-[ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-[ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-[ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
Fastfile:
This is the actual file which includes the lane. Refer the fastfile from this repo which includes the lanes for build, firebase app distribution and Google play upload.
***
For more details refer: https://docs.fastlane.tools/getting-started/android/setup/
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Jenkins VM Setup
Setup a Jenkins VM and install the below software.
## Suggestions for a good README
Install Java
Follow the instructions in the guide https://www.digitalocean.com/community/tutorials/how-to-install-java-with-apt-on-ubuntu-22-04
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
Install Android SDK
Refer to the steps provided https://linuxopsys.com/topics/install-android-sdk-without-android-studio-on-ubuntu
## Name
Choose a self-explaining name for your project.
Install Fastlane
Follow the steps outlined in https://linuxopsys.com/topics/install-android-sdk-without-android-studio-on-ubuntu
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Jenkins Configuration
Setup the Webhook in the Project Repo so that when the development team pushes the changes to the repo, it will trigger the pipeline.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
Set Android SDK Root in Jenkins:
> Go to Manage Jenkins -> System -> Android SDK.
> Add the path of the Android SDK in your Jenkins VM.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
Create Jenkins Job:
> Create a new Jenkins job with pipeline configuration settings.
> Enable "Build when a change is pushed to GitLab" in Build Triggers.
> Choose "Pipeline script from SCM" in Pipeline definition.
> Set SCM to Git.
> Enter the repository URL of your GitLab repo.
> Choose the appropriate credentials.
> Specify the branch name.
> Set the repository browser to Auto.
> Set the script path to Jenkinsfile.
> Click on Save button
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
Refer the 'Jenkinsfile' in the repo for the pipeline stages which creates the Android build and pushes it to Firebase App Distribution and Google Play Store
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
## Dependencies:
1) Jenkins VM setup with required software installation as mention above
2) Firebase setup to get the service account and store it in the Jenkins VM - https://firebase.google.com/docs/app-distribution/android/distribute-fastlane
3) Google play store setup - create a service account and provide the required permission to the SA in the Google Playstore console. - https://devjorgecastro.medium.com/how-to-deploy-your-android-app-to-the-internal-track-in-the-play-store-console-using-fastlane-4f66efdabc12
4) For the first time, we need to manually upload the Android app to the Google Playstore atleast once.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
