Skip to content

Commit 4f08ed1

Browse files
authored
Add CI build (#2)
1 parent 6fb7346 commit 4f08ed1

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

.github/workflows/ci.yaml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: CI
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- main
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout/install
14+
uses: adamhamlin/checkout-node-project@v0.1.0
15+
16+
- name: Run Tests
17+
run: npm run test:ci

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Deep Equality Javascript Data Structures
22

3+
[![CI Status Badge](https://github.com/adamhamlin/deep-equality-data-structures/actions/workflows/ci.yaml/badge.svg)](https://github.com/adamhamlin/deep-equality-data-structures/actions/workflows/ci.yaml)
4+
35
A drop-in replacement for ES native `Map` and `Set` with deep equality support for objects.
46

57
## Why?
@@ -81,3 +83,9 @@ Additional project-specific options:
8183
8284
- Don't mutate a map key (or set value) while still using the data structure. The internal representation is not affected by this mutation, so behavior may be unexpected.
8385
- This implementation does not explicitly "handle" key collisions. However, with the default algorithm (MD5), even if a map contained one TRILLION entries, the probability of a collision on the next insert is only 0.000000000000001. If you need better odds, use SHA1, SHA256, etc.
86+
87+
## CI/CD
88+
89+
Using Github Actions, the CI build will run on all pull requests and pushes/merges to main.
90+
91+
This project uses [Conventional Commits](https://www.conventionalcommits.org/) and [standard-version](https://github.com/conventional-changelog/standard-version) to facilitate versioning and changelogs.

0 commit comments

Comments
 (0)