Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Devin Wang committed Aug 26, 2023
1 parent 9731920 commit 6266d5a
Showing 1 changed file with 19 additions and 5 deletions.
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,30 @@
# go ci workflow
![Coverage](https://img.shields.io/badge/Coverage-100.0%25-brightgreen)
[![CI](https://github.com/devinwangg/go-github-action/workflows/CI/badge.svg)](https://github.com/devinwangg/go-github-action/workflows/CI/badge.svg)
[![Go Report Card](https://goreportcard.com/badge/devinwangg/go-ci-workflow)](https://goreportcard.com/badge/devinwangg/go-ci-workflow)

## Project Description
This repository showcases a Continuous Integration (CI) workflow for a Golang project using GitHub Actions and Codecov. The CI pipeline automatically builds the code, runs unit tests, and reports code coverage metrics via Codecov.

## Features
Automated code build using GitHub Actions
Automated unit tests
Code coverage reporting via Codecov
Easy-to-follow GitHub Action YML configuration files
Support for multiple Go versions
- Automated Code Build
Utilizes GitHub Actions for automated code builds.
- Automated Unit Tests
Automated unit tests to ensure code quality.
- Code Coverage Reporting
Reports code coverage via Codecov.
- Easy-to-Follow Configuration
Contains easy-to-follow GitHub Action YAML configuration files.
- Multi-Version Support
Supports multiple versions using semantic versioning.

## Workflow
This repository demonstrates the implementation of four workflow jobs:

1. Unit Testing: Automatically runs unit tests to ensure code functionality.
2. Golang Style Checker: Uses the `golangci-lint` tool to check code style and quality.
3. Unit Testing Coverage Badge: Generates a badge indicating the coverage percentage of unit tests.
4. Semantic Versioning: Implements semantic versioning to manage versions of the project.

## Pre-requisites
- Github Account Token
Expand Down

0 comments on commit 6266d5a

Please sign in to comment.