Skip to content

Commit a32bc2d

Browse files
committed
Merge branch 'release/1.2.1'
2 parents c97aad6 + 93c0057 commit a32bc2d

File tree

5 files changed

+6398
-16054
lines changed

5 files changed

+6398
-16054
lines changed

.circleci/config.yml

+9-7
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,13 @@ jobs:
2222

2323
- run:
2424
name: Install global packages
25-
command: sudo npm install -g codecov greenkeeper-lockfile@1
25+
command: sudo npm install -g codecov
2626

2727
- run:
28-
name: Greenkeeper Lockfile
29-
command: greenkeeper-lockfile-update
28+
name: Install dockerize
29+
command: wget https://github.com/jwilder/dockerize/releases/download/$DOCKERIZE_VERSION/dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz && sudo tar -C /usr/local/bin -xzvf dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz && rm dockerize-linux-amd64-$DOCKERIZE_VERSION.tar.gz
30+
environment:
31+
DOCKERIZE_VERSION: v0.6.1
3032

3133
- run:
3234
name: Install dependencies
@@ -46,12 +48,12 @@ jobs:
4648
command: npm run test:unit:cov
4749

4850
- run:
49-
name: Integration Tests
50-
command: npm run test:integration
51+
name: Wait for RabbitMQ to have started
52+
command: dockerize -wait tcp://localhost:5672 -timeout 1m
5153

5254
- run:
53-
name: Push any lockfile changes
54-
command: greenkeeper-lockfile-upload
55+
name: Integration Tests
56+
command: npm run test:integration
5557

5658
- run:
5759
name: Send reports to codecov.io

CONTRIBUTING.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ See this handy, if ugly, [cheat sheet](http://danielkummer.github.io/git-flow-ch
1616
2. clone your fork to your local development machine
1717
3. Set this repo as the `upstream` repo `git remote add upstream <insert the upstream url>`
1818
4. Disallow direct pushing to upstream `git remote set-url --push upstream no_push`
19-
5. create a local `master` branch `git checkout -b master` and test it via `git pull upstream master`
19+
5. create a local `main` branch `git checkout -b main` and test it via `git pull upstream main`
2020
6. ensure you have installed the [`git-flow` command line helpers](https://github.com/nvie/gitflow) and [`git-flow-completion` utils](https://github.com/bobthecow/git-flow-completion) then run `git flow init -d`.
2121

2222
#### Optional Git Setup
@@ -46,15 +46,15 @@ git config user.email "[email protected]"
4646

4747
#### Hotfixes and Support branches
4848

49-
It's basically the same process but use the word `hotfix` or `support` instead of `feature`. `git flow` knows what to do. Just keep in mind that any changes are going to happen to your fork, and not the upstream repo. If you need to merge a `hotfix` into upstream master you may only do it va a reviewed pull request.
49+
It's basically the same process but use the word `hotfix` or `support` instead of `feature`. `git flow` knows what to do. Just keep in mind that any changes are going to happen to your fork, and not the upstream repo. If you need to merge a `hotfix` into upstream main you may only do it va a reviewed pull request.
5050

5151
### Releasing to production
5252

5353
1. `git flow release start {tag.number}` (using semantic versioning)
5454
2. commit any changes to version info in `package.json` then `git flow release publish {tag.number}`
55-
3. `git flow release finish {tag.number}` merges the release into `master` of your fork, tags it, merges that back into `develop` on your fork and removes the release branch.
56-
4. Now go back to GitHub and raise a Pull Request to merge the upstream master from your fork's `master` branch. When that goes through you are done.
57-
5. In your command-line go back and clean up any outstanding branches and `git pull upstream` your local `master` and `develop` branches to ensure everything on your local machine is up to date with everyone's changes.
55+
3. `git flow release finish {tag.number}` merges the release into `main` of your fork, tags it, merges that back into `develop` on your fork and removes the release branch.
56+
4. Now go back to GitHub and raise a Pull Request to merge the upstream main from your fork's `main` branch. When that goes through you are done.
57+
5. In your command-line go back and clean up any outstanding branches and `git pull upstream` your local `main` and `develop` branches to ensure everything on your local machine is up to date with everyone's changes.
5858

5959
Note you will **never** push changes directly to the upstream project, _only to your own fork_.
6060

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ A Pub Sub system that uses `AMQP` messaging to exchange data between services.
66

77
## To Use
88

9-
You project needs to be using at least Node version 10, and ideally Node 14 (LTS) or later.
9+
You project needs to be using at least Node version 10, and ideally Node 18 (LTS) or later.
1010

1111
```sh
1212
npm install amqp-simple-pub-sub
@@ -109,11 +109,11 @@ See some examples in the tests, and also:
109109
| Branch | Tests | Code Coverage | Audit | Comments |
110110
| ------ | ----- | ------------- | ----- | -------- |
111111
| `develop` | [![CircleCI](https://circleci.com/gh/davesag/amqp-simple-pub-sub/tree/develop.svg?style=svg)](https://circleci.com/gh/davesag/amqp-simple-pub-sub/tree/develop) | [![codecov](https://codecov.io/gh/davesag/amqp-simple-pub-sub/branch/develop/graph/badge.svg)](https://codecov.io/gh/davesag/amqp-simple-pub-sub) | [![Vulnerabilities](https://snyk.io/test/github/davesag/amqp-simple-pub-sub/develop/badge.svg)](https://snyk.io/test/github/davesag/amqp-simple-pub-sub/develop) | Work in progress |
112-
| `master` | [![CircleCI](https://circleci.com/gh/davesag/amqp-simple-pub-sub/tree/master.svg?style=svg)](https://circleci.com/gh/davesag/amqp-simple-pub-sub/tree/master) | [![codecov](https://codecov.io/gh/davesag/amqp-simple-pub-sub/branch/master/graph/badge.svg)](https://codecov.io/gh/davesag/amqp-simple-pub-sub) | [![Vulnerabilities](https://snyk.io/test/github/davesag/amqp-simple-pub-sub/master/badge.svg)](https://snyk.io/test/github/davesag/amqp-simple-pub-sub/master) | Latest release |
112+
| `main` | [![CircleCI](https://circleci.com/gh/davesag/amqp-simple-pub-sub/tree/main.svg?style=svg)](https://circleci.com/gh/davesag/amqp-simple-pub-sub/tree/main) | [![codecov](https://codecov.io/gh/davesag/amqp-simple-pub-sub/branch/main/graph/badge.svg)](https://codecov.io/gh/davesag/amqp-simple-pub-sub) | [![Vulnerabilities](https://snyk.io/test/github/davesag/amqp-simple-pub-sub/main/badge.svg)](https://snyk.io/test/github/davesag/amqp-simple-pub-sub/main) | Latest release |
113113

114114
### Prerequisites
115115

116-
- [NodeJS](htps://nodejs.org), 10.0+ (I use [`nvm`](https://github.com/creationix/nvm) to manage Node versions — `brew install nvm`.)
116+
- [NodeJS](https://nodejs.org), 10.0+ (I use [`nvm`](https://github.com/creationix/nvm) to manage Node versions — `brew install nvm`.)
117117
- [Docker](https://www.docker.com) (Use [Docker for Mac](https://docs.docker.com/docker-for-mac/), not the homebrew version)
118118

119119
### Initialisation
@@ -122,7 +122,7 @@ See some examples in the tests, and also:
122122
npm install
123123
```
124124

125-
### To Start the queue server for integration testing.
125+
### To Start the queue server for integration testing
126126

127127
```sh
128128
docker-compose up -d

0 commit comments

Comments
 (0)