Skip to content

Commit

Permalink
Add CI/CD information to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tnsoftbear committed Nov 4, 2024
1 parent 8939487 commit c39e507
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ The [testify](https://github.com/stretchr/testify) library is used for unit test

E2E testing of the API is implemented using the [hurl](https://hurl.dev/) command line tool. You can run the tests with the command `make testapi`, which will build and start the necessary containers and then execute the hurl test requests.

## Github Actions

The repository includes GitHub Actions pipelines that first use a linter to check the Go code syntax, followed by the execution of unit tests. If these verification steps succeed, the application is built into a Docker container, which is then deployed to the GitHub Container Registry.

## Contribution

Since this is a learning project focused on microservices with Golang, I would be incredibly grateful for any advice or ideas for improvement!
Expand Down

0 comments on commit c39e507

Please sign in to comment.