Skip to content

Commit 193fb8c

Browse files
committed
MLN-2317 | fix: README
1 parent a7e76c8 commit 193fb8c

File tree

2 files changed

+11
-18
lines changed

2 files changed

+11
-18
lines changed

.github/workflows/CI.yml

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,17 @@ jobs:
1515
persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal access token.
1616
fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository.
1717

18-
- uses: actions/setup-go@v3
18+
- uses: actions/setup-go@v2
19+
with:
20+
go-version: '1.18'
21+
22+
- name: Verify dependencies
23+
run: |
24+
go get -v -t ./...
25+
go mod verify
26+
27+
- name: Build
28+
run: make build
1929

2030
- name: SWAP
2131
run: |
@@ -24,12 +34,6 @@ jobs:
2434
sudo swapoff $PARTITION
2535
sudo swapon -s
2636
27-
- name: Verify dependencies
28-
run: go mod verify
29-
30-
- name: Build
31-
run: make build
32-
3337
- name: Test
3438
run: make test_coverage
3539

@@ -58,11 +62,3 @@ jobs:
5862
with:
5963
github_token: ${{ github.token }}
6064
branch: ${{ github.head_ref }}
61-
62-
- name: Lint
63-
uses: golangci/golangci-lint-action@v3
64-
with:
65-
version: v1.42.1
66-
args: -c .golangci.yml --timeout=10m
67-
skip-pkg-cache: true
68-
skip-build-cache: true

README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@
77

88
Library that helps to limit memory consumption of your Go service.
99

10-
Notice: All APIs in this package are experimental and may be removed in a
11-
later release.
12-
1310
## Working principles
1411
As of today (Go 1.18), there is a possibility for any Go application to be eventually stopped by OOM killer. The memory leak is because Go runtime knows nothing about the limitations imposed on the process by the operating system (for instance, using `cgroups`). However, an unexpected termination of a process because of OOM is highly undesirable, as it can lead to cache resetting, data integrity violation, distributed transaction hanging and even cascading failure of a distributed backend. Therefore, services should degrade gracefully instead of immediate stop due to `SIGKILL`.
1512

0 commit comments

Comments
 (0)