Implementation of GitHub Actions

[PhilippSchmelter]

Closes #540

This pull request introduces a comprehensive CI/CD pipeline using GitHub Actions, implements semantic versioning, and adds automated branch name validation. The key changes are grouped into CI/CD pipeline setup, semantic versioning tasks, and branch name validation.

CI/CD Pipeline Setup:

• Added a CI workflow to build, test, and deploy the project using GitHub Actions. This includes steps for checking out the source, setting up Java and Gradle, running tests, and deploying to Maven Central. (.github/workflows/ci.yml)
• Created a workflow to automatically merge Dependabot pull requests if they meet specific criteria. (.github/workflows/dependabot-auto-merge.yml)

Semantic Versioning:

• Added Gradle tasks for managing and printing the current and development versions based on semantic versioning. (gradle/scripts/semVer.gradle)
• Introduced scripts to fetch and compare versions from different branches to enforce versioning rules during pull requests. (scripts/get_versions.sh, scripts/run-version-check.sh, scripts/version_check.sh) [1] [2] [3]
• Updated version.properties to include semantic versioning details. (version.properties)

Branch Name Validation:

• Implemented a Gradle task to validate branch names against predefined patterns to ensure they follow the required naming conventions. (gradle/scripts/branchName.gradle)
• Added a script to determine the branch type based on its name and set the corresponding environment variable. (scripts/branch_type.sh)

Documentation:

• Updated the CHANGELOG.md to include the addition of the GitHub Actions pipeline. (CHANGELOG.md)

[Copilot]

Copilot reviewed 4 out of 11 changed files in this pull request and generated no comments.

Files not reviewed (7)

• gradle/scripts/branchName.gradle: Language not supported
• gradle/scripts/semVer.gradle: Language not supported
• scripts/branch_type.sh: Language not supported
• scripts/get_versions.sh: Language not supported
• scripts/run-version-check.sh: Language not supported
• scripts/version_check.sh: Language not supported
• version.properties: Language not supported

Comments suppressed due to low confidence (2)

.github/workflows/dependabot-auto-merge.yml:21

• Ensure the GitHub CLI ('gh') is available in the runner environment. Without it, the auto-merge step may fail; alternatively, consider using an existing GitHub Action to merge pull requests.

run: gh pr merge --auto --merge "$PR_URL"

.github/workflows/ci.yml:90

• [nitpick] For consistency with earlier steps that extract the branch name into BRANCH_NAME, consider revisiting the deployment condition to use a unified variable reference.

if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev'

[Copilot]

Copilot reviewed 4 out of 11 changed files in this pull request and generated no comments.

Files not reviewed (7)

• gradle/scripts/branchName.gradle: Language not supported
• gradle/scripts/semVer.gradle: Language not supported
• scripts/branch_type.sh: Language not supported
• scripts/get_versions.sh: Language not supported
• scripts/run-version-check.sh: Language not supported
• scripts/version_check.sh: Language not supported
• version.properties: Language not supported

[sebastian-peter]

@PhilippSchmelter Similar feedback to ie3-institute/MobilitySimulator#352 (review):

I think if we get semver in first, this should work :)

[sonarqubegithubprchecks]

Analysis Details

0 Issues

• 0 Bugs
• 0 Vulnerabilities
• 0 Code Smells

Coverage and Duplications

• No coverage information (65.80% Estimated after merge)
• No duplication information (0.00% Estimated after merge)

Project ID: edu.ie3:utils

View in SonarQube

[sebastian-peter]

Looks good, let's give it a try also in here!