diff --git a/.github/workflows/build-test.yml b/.github/workflows/build.yml similarity index 96% rename from .github/workflows/build-test.yml rename to .github/workflows/build.yml index 53a0487..7915a8b 100644 --- a/.github/workflows/build-test.yml +++ b/.github/workflows/build.yml @@ -1,4 +1,4 @@ -name: Build and Test +name: Build on: pull_request: @@ -7,7 +7,7 @@ on: branches: [ main ] jobs: - build-test: + build: runs-on: ubuntu-latest env: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0435a02..a621102 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,12 +36,14 @@ Here are a few things you can do that will increase the likelihood of your pull [Act](https://github.com/nektos/act) is a tool that will use docker to build and test workflows locally. #### 1. Act setup + - Follow the [instructions](https://github.com/nektos/act?tab=readme-ov-file#installation) to install act - To check all available actions: `act -l` #### 2. Run tests + - To run the default (push) event: `act` -- To run a specific job: `act -j build-test` +- To run a specific job: `act -j build` Alternatively, you can run unit and integration tests with the following commands: diff --git a/README.md b/README.md index df75ee2..1f33641 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# LoadShedding · [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/farfetch/loadshedding/blob/main/LICENSE) [![nuget version](https://img.shields.io/nuget/v/loadshedding.svg?style=flat)](https://www.nuget.org/packages/Farfetch.LoadShedding/) ![Build Master](https://github.com/Farfetch/loadshedding/workflows/Build/badge.svg?branch=main) +# LoadShedding · [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/farfetch/loadshedding/blob/main/LICENSE) [![NuGet](https://img.shields.io/nuget/v/farfetch.loadshedding.svg?style=flat)](https://www.nuget.org/packages/Farfetch.LoadShedding/) ![Build](https://github.com/Farfetch/loadshedding/workflows/Build/badge.svg?branch=main) ## Introduction -⚡️ LoadShedding was designed to effectively manage concurrency in the .NET ecosystem. +⚡️ LoadShedding was designed to effectively manage concurrency in the .NET ecosystem. 🏗 Built upon the foundational principles and concepts pioneered by [Netflix](https://netflixtechblog.medium.com/performance-under-load-3e6fa9a60581).