Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/evgeny-nik/project_github_actions_ci_cd_maven_app
a project to learn workflow of GitHub actions, and integrate it with Maven and a Docker
https://github.com/evgeny-nik/project_github_actions_ci_cd_maven_app
docker github-actions maven
Last synced: 7 days ago
JSON representation
a project to learn workflow of GitHub actions, and integrate it with Maven and a Docker
- Host: GitHub
- URL: https://github.com/evgeny-nik/project_github_actions_ci_cd_maven_app
- Owner: Evgeny-Nik
- Created: 2024-07-09T08:50:53.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-07-11T07:30:38.000Z (4 months ago)
- Last Synced: 2024-07-11T13:59:00.990Z (4 months ago)
- Topics: docker, github-actions, maven
- Language: HCL
- Homepage:
- Size: 18.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CI/CD Project for Containerized simple-java-maven-app
## Source code
The project uses a fork of the following app: \
https://github.com/jenkins-docs/simple-java-maven-app
## GitHub Actions CI/CD Stages
This GitHub Actions workflow automates the process of building, tagging, and pushing a Docker image of a Java application, provisioning an AWS EC2 instance using Terraform, and running the Docker image on that EC2 instance.
## Workflow Overview
### Trigger:
The workflow is triggered on Push event to the `master` branch in the following paths:
```yaml
on:
push:
branches:
- "master"
paths:
- 'src/**'
- 'tf-files/**'
- '.github/workflows/**'
- 'Dockerfile'
- 'pom.xml'
```
## Jobs:
The workflow consists of two main jobs:
1. **Build**: Checks out the repository, increments the version in the `pom.xml` file, builds and tags the Docker image, and pushes it to Docker Hub.
2. **Provision-EC2**: Provisions an EC2 instance using Terraform. It requires the successful completion of the `build` job.
## Steps
### 1. Job - Build
- Checkout the repository.
- Increment version in `pom.xml`.
- Get the new version from `pom.xml`.
- Build a Docker image and tag it as a new version.
- Tag the Docker image as `latest`.
- Login to Docker Hub registry (configure your secrets in GitHub).
- Push both versions (new version and `latest`) to Docker Hub.
### 2. Job - Provision EC2
- Checkout the repository.
- Configure AWS credentials.
- Initialize, validate, and apply Terraform to provision the EC2 instance.
## Multi-Stage Dockerfile
### Build and Tag Image
```bash
docker build -t ${DOCKERHUB_USERNAME}/github_app:${{env.VERSION}} --build-arg APP_VERSION=${{env.VERSION}} .
```
## Run Program Locally
```bash
docker run ${DOCKERHUB_USERNAME}/github_app:latest
```
### Inside Dockerfile
#### Arguments & Environment Variables
`ARG APP_VERSION` - Get argument for image building
`ENV APP my-app-$APP_VERSION.jar` - Set environment variable for execution.
#### Stage 1: Build
- Copy source code.
- Compile Java application and create JAR file.
#### Stage 2: Run
- Copy JAR file from the build stage.
- Execute the program when running the image.
## Versioning Logic
The project adheres to semantic versioning (Major.Minor.Patch) to ensure a structured and predictable versioning system.
- Increment version: This step uses a plugin to change the version number in the `pom.xml` file.
```yaml
- name: Increment version
uses: mickem/[email protected]
with:
pom-file: 'pom.xml'
```
## Plugin Used
#### GitHub Actions:
- ***actions/checkout@v4*** - Allows you to take actions on your source code.
- ***[docker/login-action@v3](https://github.com/docker/login-action)*** - Allows you to log in against a Docker registry.
- ***[mickem/[email protected]](https://github.com/mickem/gh-action-bump-maven-version)*** - Allows you to increment the version in your Maven `pom.xml` file.
- ***[aws-actions/[email protected]](https://github.com/aws-actions/configure-aws-credentials)*** - Configures AWS credentials for use in GitHub Actions.
- ***[hashicorp/setup-terraform@v2](https://github.com/hashicorp/setup-terraform)*** - Sets up Terraform in GitHub Actions.
#### DockerFile:
- ***maven:3.8.6*** - Docker Image for building Java applications using Maven.
- ***openjdk:17-jdk-slim*** - Docker Image for running Java applications.
## Reproducing the Project
To reproduce this project, follow these steps:
1. **Fork and Clone the Repository**:
```bash
git clone https://github.com/yourusername/simple-java-maven-app.git
cd simple-java-maven-app
```
2. **Set Up GitHub Secrets**:
- Go to your repository on GitHub.
- Navigate to Settings > Secrets and Variables > Actions.
- Add the following secrets:
- `DOCKERHUB_USERNAME`
- `DOCKERHUB_PASSWORD`
- `AWS_ACCESS_KEY_ID`
- `AWS_SECRET_ACCESS_KEY`
- `AWS_REGION`
3. **(Optional) To Run Terraform commands Locally Configure Terraform Variables**:
- Navigate to the `tf-files` directory.
- Create a `terraform.tfvars` file and add your AWS configuration:
```hcl
aws_access_key = "YOUR_AWS_ACCESS_KEY"
aws_secret_key = "YOUR_AWS_SECRET_KEY"
region = "YOUR_AWS_REGION"
```
4. **Run the Workflow**:
- Push changes to the `master` branch.
- The workflow will trigger and execute the defined jobs.
## Links
- [Simple Java Maven App](https://github.com/jenkins-docs/simple-java-maven-app)
- [DockerHub Project Registry](https://hub.docker.com/repository/docker/evgenyniko/github_app)