Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add git actions documentation #5

Merged
merged 1 commit into from
Oct 18, 2024
Merged

Add git actions documentation #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,34 @@
# DotNet Setup
1. From [DockerFile directory](/KeyCloakIntegration/) run: `docker build -t dotnet_keycloak-image -f DockerFile .`
1. Start app with the following command `docker run -d -p 8081:8080 dotnet_keycloak-image`
1. Navigate to [app]((http://localhost:8081/)
1. Navigate to [app]((http://localhost:8081/)

# GitHub Actions

This repository uses [GitHub Actions](https://github.com/features/actions) for Continuous Integration (CI) to ensure code quality and project health.

## Active GitHub Actions

Currently, the following workflows are active:

1. **Build and Test Workflow**:
- **Trigger**: This workflow runs on every push and pull request to the `main` branch.
- **Purpose**: It automatically builds the solution and runs all unit tests using the `.NET Core` framework.
- **Command**: The workflow uses `dotnet test` with the filter `FullyQualifiedName~UnitTests` to ensure only unit tests are executed.

**Why it matters**:
Continuous testing is critical to the development process because it provides immediate feedback on the health of the codebase. Every change is verified automatically, helping detect bugs early and reducing the risk of breaking production code. By keeping the tests up-to-date, you ensure the project remains maintainable and scalable.

## Benefits of CI with GitHub Actions

- **Early Bug Detection**: By running tests on every push and pull request, developers are alerted to issues early, preventing regressions and maintaining code quality.
- **Consistent Builds**: Ensures that the project builds consistently across environments and catches build issues before they make it to production.
- **Automated Testing**: Automates the process of running tests, which saves time and encourages developers to write and maintain a comprehensive test suite.
- **Improved Code Quality**: Automated workflows provide continuous assurance that code adheres to defined quality standards, including passing tests and compiling correctly.

## How to View CI Results

1. Navigate to the "Actions" tab of the repository to view recent workflow runs.
2. Click on a specific workflow run to view the detailed output of the build and test process.

These CI workflows are essential for maintaining project health, ensuring that code changes are reliable, and providing a strong foundation for future development.
Loading