Skip to content
This repository was archived by the owner on Nov 18, 2024. It is now read-only.

Commit b493cd5

Browse files
authored
prepare 2.0.0-rc.1 release (#8)
1 parent aa73b08 commit b493cd5

File tree

4 files changed

+70
-12
lines changed

4 files changed

+70
-12
lines changed

.eslintignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
node_modules/
22
test-types.js
3+
.eslintrc.js

CHANGELOG.md

+8
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
All notable changes to the LaunchDarkly Node.js SDK Consul integration will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
44

5+
## [2.0.0-rc.1] - 2021-06-15
6+
7+
_This is a release candidate version corresponding to the current projected state of the 2.0.0 release. The final 2.0.0 release may include additional functionality or fixes._
8+
9+
The 2.0.0 release of `launchdarkly-node-server-sdk-consul` is for use with version 6.x of the LaunchDarkly server-side SDK for Node.js. It has the same functionality as the previous major version, but its dependencies, Node version compatibility, and internal API have been updated to match the 6.0.0 release of the SDK.
10+
11+
This version uses the same Consul client package as previous releases.
12+
513
## [1.0.5] - 2020-03-25
614
### Removed:
715
- The package dependencies mistakenly included `typedoc`.

CONTRIBUTING.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Contributing to this library
2+
3+
The source code for this library is [here](https://github.com/launchdarkly/node-server-sdk-consul). We encourage pull-requests and other contributions from the community. Since this library is meant to be used in conjunction with the LaunchDarkly Server-Side Node.js SDK, you may want to look at the [SDK source code](https://github.com/launchdarkly/dotnet-server-sdk) and our [SDK contributor's guide](http://docs.launchdarkly.com/docs/sdk-contributors-guide).
4+
5+
## Submitting bug reports and feature requests
6+
7+
The LaunchDarkly SDK team monitors the [issue tracker](https://github.com/launchdarkly/node-server-sdk-consul/issues) in this repository. Bug reports and feature requests specific to this project should be filed in the issue tracker. The SDK team will respond to all newly filed issues within two business days.
8+
9+
## Submitting pull requests
10+
11+
We encourage pull requests and other contributions from the community. Before submitting pull requests, ensure that all temporary or unintended code is removed. Don't worry about adding reviewers to the pull request; the LaunchDarkly SDK team will add themselves. The SDK team will acknowledge all pull requests within two business days.
12+
13+
## Build instructions
14+
15+
### Prerequisites
16+
17+
The project uses `npm`, which is bundled in all supported versions of Node. It should be built against the lowest compatible version, Node 12.
18+
19+
### Setup
20+
21+
To install project dependencies, from the project root directory:
22+
23+
```
24+
npm install
25+
```
26+
27+
### Testing
28+
29+
To run all unit tests:
30+
31+
```
32+
npm test
33+
```
34+
35+
The tests expect you to have Consul running locally. A simple way to do this is with Docker:
36+
37+
```bash
38+
docker run -p 8500:8500 consul
39+
```
40+
41+
To verify that the TypeScript declarations compile correctly (this involves compiling the file `test-types.ts`, so if you have changed any types or interfaces, you will want to update that code):
42+
43+
```
44+
npm run check-typescript
45+
```

package.json

+16-12
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "launchdarkly-node-server-sdk-consul",
3-
"version": "1.0.5",
3+
"version": "2.0.0-rc.1",
44
"description": "Consul-backed feature store for the LaunchDarkly Node.js SDK",
55
"main": "consul_feature_store.js",
66
"license": "Apache-2.0",
@@ -11,16 +11,20 @@
1111
},
1212
"types": "./index.d.ts",
1313
"devDependencies": {
14-
"@babel/core": "^7.4.3",
15-
"@babel/preset-env": "^7.4.3",
16-
"babel-jest": "^24.7.1",
17-
"eslint": "^6.5.1",
18-
"eslint-formatter-pretty": "^3.0.1",
19-
"jest": "^24.7.1",
20-
"jest-junit": "^6.3.0",
21-
"launchdarkly-js-test-helpers": "^1.0.0",
22-
"launchdarkly-node-server-sdk": "^6.0.0-alpha.1",
23-
"typescript": "^3.8.3"
14+
"@babel/core": "^7.14.6",
15+
"@babel/preset-env": "^7.14.5",
16+
"@types/node": "^15.12.2",
17+
"babel-jest": "^27.0.2",
18+
"eslint": "^7.28.0",
19+
"eslint-config-prettier": "^8.3.0",
20+
"eslint-formatter-pretty": "^4.1.0",
21+
"eslint-plugin-prettier": "^3.4.0",
22+
"jest": "^27.0.4",
23+
"jest-junit": "^12.2.0",
24+
"launchdarkly-js-test-helpers": "^1.2.1",
25+
"launchdarkly-node-server-sdk": "^6.0.0-rc.1",
26+
"prettier": "^2.3.1",
27+
"typescript": "^4.3.2"
2428
},
2529
"jest": {
2630
"rootDir": ".",
@@ -36,7 +40,7 @@
3640
"node-cache": "4.2.0"
3741
},
3842
"peerDependencies": {
39-
"launchdarkly-node-server-sdk": "^6.0.0-alpha.1"
43+
"launchdarkly-node-server-sdk": "^6.0.0-rc.1"
4044
},
4145
"engines": {
4246
"node": ">= 12.0"

0 commit comments

Comments
 (0)