Skip to content

Commit

Permalink
Bump version and add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zuiderkwast committed Jun 30, 2021
1 parent adaa51f commit 4001fe5
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 2 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# CHANGELOG

## v1.4.1

June 2021.

* Restore support for rebar 2.
* Optimize parser.

## v1.4.0

June 2021.
Expand Down
28 changes: 28 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Contributing to eredis
======================

Requirements: Erlang/OTP, rebar3 and make. For tests, also Docker and OpenSSL.

* `make test` runs the tests using Docker and generates TLS certificates using
OpenSSL. If you can't run it or if some test (e.g. the IPv6 test) fails, it's
fine as long as it passes in the automated builds.
* When docs are affected, run `make edoc` and commit the changed Markdown files
under `doc/`.
* Don't update the version unless agreed with the maintainers.

Releasing a new version
-----------------------

Normally done by the maintainers.

* Update the version in `src/eredis.app.src` and `mix.exs`.
* Update CHANGELOG.md and add what's new since the last version. (Use e.g. `git
log *PREV_VERSION*..HEAD`).
* Check that documentation is generated and commited using `make edoc`.
* Commit the changes, push and check the build.
* Publish to Hex using `make publish` (requires `mix` and a Hex account with
rights to publish this project). (This can be done later.)
* Create an annotated tag on the form vMAJOR.MINOR.PATCH, `git tag -a v0.0.0`.
Write a very short message with the most important changes (one line or a few
bullets).
* Push the tag using `git push --tags`.
2 changes: 1 addition & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ defmodule Eredis.Mixfile do
use Mix.Project

@source_url "https://github.com/Nordix/eredis/"
@version "1.4.0"
@version "1.4.1"

def project do
[
Expand Down
2 changes: 1 addition & 1 deletion src/eredis.app.src
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{application,eredis,
[{description,"Erlang Redis Client"},
{vsn,"1.4.0"},
{vsn,"1.4.1"},
{modules,[eredis,eredis_client,eredis_parser,eredis_sub,
eredis_sub_client]},
{registered,[]},
Expand Down

0 comments on commit 4001fe5

Please sign in to comment.