Skip to content

Commit

Permalink
Prepare 1.0.0-alpha1 release (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
zurab-darkly authored Jul 25, 2019
1 parent 010ae14 commit fcf7b0a
Show file tree
Hide file tree
Showing 51 changed files with 14,268 additions and 0 deletions.
50 changes: 50 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
version: 2

workflows:
version: 2
test:
jobs:
- test-elixir-otp21
- test-21
- test-22

erlang-docker-template: &erlang-docker-template
steps:
- checkout:
path: ~/eld
- run:
name: install dependencies and compile
command: make
working_directory: ~/eld
- run:
name: run tests
command: make tests
working_directory: ~/eld
- run:
name: run dialyzer
command: make dialyze
working_directory: ~/eld
- run:
name: make test-results directory
command: mkdir test-results
working_directory: ~/eld
- run:
name: copy test results
command: cp logs/*/junit_report.xml test-results/
working_directory: ~/eld
- store_test_results:
path: ~/eld/test-results

jobs:
test-elixir-otp21:
<<: *erlang-docker-template
docker:
- image: circleci/elixir:otp-21
test-21:
<<: *erlang-docker-template
docker:
- image: circleci/erlang:21.3.8
test-22:
<<: *erlang-docker-template
docker:
- image: circleci/erlang:22.0.1
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
erlang.mk -diff
18 changes: 18 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
.erlang.mk
.eunit
.idea
*.iml
*.kdev4
*.o
*.plt
_rel
deps
ebin
erl_crash.dump
logs
test/*.beam
eld.d
.DS_Store
_build/
rebar.lock

16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Change log

All notable changes to the LaunchDarkly Erlang/Elixir SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).

## [1.0.0-alpha1] - 2019-07-24

### Added

- Initial public release
- Support for streaming and evaluations

### Missing

- Events don't pass integration tests
- Polling support
- Other known issues and minor missing features
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Contributing to the LaunchDarkly Server-Side SDK for Erlang/Elixir

LaunchDarkly has published an [SDK contributor's guide](https://docs.launchdarkly.com/docs/sdk-contributors-guide) that provides a detailed explanation of how our SDKs work. See below for additional information on how to contribute to this SDK.

## Submitting bug reports and feature requests

The LaunchDarkly SDK team monitors the [issue tracker](https://github.com/launchdarkly/erlang-server-sdk/issues) in the SDK repository. Bug reports and feature requests specific to this SDK should be filed in this issue tracker. The SDK team will respond to all newly filed issues within two business days.

## Submitting pull requests

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.

## Build instructions

### Prerequisites

This project can be built with either [rebar3](https://www.rebar3.org/) or [erlang.mk](https://erlang.mk/).

### Installing dependencies

From the project root directory:

```
make
```

### Testing

To run all unit tests:

```
make tests
```
13 changes: 13 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Copyright 2019 Catamorphic, Co.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
23 changes: 23 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
PROJECT = eld
PROJECT_DESCRIPTION = Erlang LaunchDarkly SDK Client
PROJECT_VERSION = 1.0.0-alpha1

# Dependencies

LOCAL_DEPS = inets crypto asn1 public_key ssl

DEPS = shotgun jsx verl lru backoff
dep_shotgun = git https://github.com/inaka/shotgun master
dep_jsx = git https://github.com/talentdeficit/jsx v2.9.0
dep_verl = git https://github.com/jelly-beam/verl.git v1.0.1
dep_lru = git https://github.com/barrel-db/erlang-lru 1.3.1
dep_backoff = git https://github.com/ferd/backoff 1.1.6

CT_OPTS = -ct_hooks cth_surefire -logdir logs

DOC_DEPS = edown
EDOC_OPTS += '{doclet,edown_doclet}'

# Standard targets

include erlang.mk
Loading

0 comments on commit fcf7b0a

Please sign in to comment.