Skip to content

Commit

Permalink
Merge branch 'release/2.0.2'
Browse files Browse the repository at this point in the history
  • Loading branch information
davesag committed Jul 30, 2022
2 parents 85a3b40 + 6bdbcf5 commit c993e0f
Show file tree
Hide file tree
Showing 6 changed files with 6,350 additions and 14,944 deletions.
45 changes: 17 additions & 28 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -1,38 +1,27 @@
version: 2
version: 2.1

jobs:
build:
docker:
- image: circleci/node:latest
orbs:
node: circleci/[email protected]
codecov: codecov/[email protected]

jobs:
test:
executor:
name: node/default
tag: 'current'
steps:
- checkout

- restore_cache:
keys:
- dependencies-v2-{{ checksum "package.json" }}

- run:
name: Install global packages
command: sudo npm install -g codecov

- run:
name: Install dependencies
command: npm install

- save_cache:
key: dependencies-v2-{{ checksum "package.json" }}
paths:
- node_modules

- node/install-packages
- run:
name: Javascript Linter
command: npm run lint

- run:
name: All Unit Tests with Code Coverage
name: Unit tests with code coverage
command: npm run test:unit:cov

- run:
name: Send reports to codecov.io
command: codecov
workflows:
node-tests:
jobs:
- test:
post-steps:
- codecov/upload
2 changes: 1 addition & 1 deletion .eslintrc.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module.exports = {
extends: ['standard', 'plugin:prettier/recommended'],
plugins: ['import', 'mocha'],
plugins: ['mocha'],
parserOptions: {
sourceType: 'module'
},
Expand Down
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ See this handy, if ugly, [cheat sheet](http://danielkummer.github.io/git-flow-ch
2. clone your fork to your local development machine
3. Set this repo as the `upstream` repo `git remote add upstream <insert the upstream url>`
4. Disallow direct pushing to upstream `git remote set-url --push upstream no_push`
5. create a local `master` branch `git checkout -b master` and test it via `git pull upstream master`
5. create a local `main` branch `git checkout -b main` and test it via `git pull upstream main`
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`.

#### Optional Git Setup
Expand Down Expand Up @@ -46,15 +46,15 @@ git config user.email "[email protected]"

#### Hotfixes and Support branches

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.
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.

### Releasing to production

1. `git flow release start {tag.number}` (using semantic versioning)
2. commit any changes to version info in `package.json` then `git flow release publish {tag.number}`
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.
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.
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.
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.
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.
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.

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

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ The following environment variables remain unset if they don't appear, or get se
- `DB_POOL_ACQUIRE` The database pool's `acquire` value.
- `DB_POOL_EVICT` The database pool's `evict` value.

#### Regarding `DATABASE_URL`.
#### Regarding `DATABASE_URL`

If you supply the `DATABASE_URL` environment variable, as Heroku and other PaaS systems generally do, then the `configure` function will extract most of what it needs from that and the extracted values will take priority over other values.

Expand Down Expand Up @@ -278,11 +278,11 @@ Note this is not used by `makeInitialiser` as it's assumed that you are only usi
| Branch | Status | Coverage | Audit | Notes |
| ------ | ------ | -------- | ----- | ----- |
| `develop` | [![CircleCI](https://circleci.com/gh/davesag/sequelize-pg-utilities/tree/develop.svg?style=svg)](https://circleci.com/gh/davesag/sequelize-pg-utilities/tree/develop) | [![codecov](https://codecov.io/gh/davesag/sequelize-pg-utilities/branch/develop/graph/badge.svg)](https://codecov.io/gh/davesag/sequelize-pg-utilities) | [![Vulnerabilities](https://snyk.io/test/github/davesag/sequelize-pg-utilities/develop/badge.svg)](https://snyk.io/test/github/davesag/sequelize-pg-utilities/develop) | Work in progress |
| `master` | [![CircleCI](https://circleci.com/gh/davesag/sequelize-pg-utilities/tree/master.svg?style=svg)](https://circleci.com/gh/davesag/sequelize-pg-utilities/tree/master) | [![codecov](https://codecov.io/gh/davesag/sequelize-pg-utilities/branch/master/graph/badge.svg)](https://codecov.io/gh/davesag/sequelize-pg-utilities) | [![Vulnerabilities](https://snyk.io/test/github/davesag/sequelize-pg-utilities/master/badge.svg)](https://snyk.io/test/github/davesag/sequelize-pg-utilities/master) | Latest stable release |
| `main` | [![CircleCI](https://circleci.com/gh/davesag/sequelize-pg-utilities/tree/main.svg?style=svg)](https://circleci.com/gh/davesag/sequelize-pg-utilities/tree/main) | [![codecov](https://codecov.io/gh/davesag/sequelize-pg-utilities/branch/main/graph/badge.svg)](https://codecov.io/gh/davesag/sequelize-pg-utilities) | [![Vulnerabilities](https://snyk.io/test/github/davesag/sequelize-pg-utilities/main/badge.svg)](https://snyk.io/test/github/davesag/sequelize-pg-utilities/main) | Latest stable release |

### Prerequisites
### Development Prerequisites

- [NodeJS](htps://nodejs.org). I use [`nvm`](https://github.com/creationix/nvm) to manage Node versions — `brew install nvm`.
- [NodeJS](https://nodejs.org). I use [`nvm`](https://github.com/creationix/nvm) to manage Node versions — `brew install nvm`.

### Test it

Expand Down
Loading

0 comments on commit c993e0f

Please sign in to comment.