Merge pull request #91 from oceanprotocol/feature/releases

New release process
2023-03-15 18:03:00 +01:00 · 2019-04-09 15:32:24 +02:00 · 2019-04-09 15:32:24 +02:00 · a21147f3a7
commit a21147f3a7
parent 3d7560648c 40d37bf8e5
8 changed files with 2437 additions and 90 deletions
--- a/.bumpversion.cfg
+++ b/.bumpversion.cfg
@ -1,7 +0,0 @@
-[bumpversion]
-current_version = 0.1.2
-
-[bumpversion:file:package.json]
-search = "version": "{current_version}",
-replace = "version": "{new_version}",
-
--- a/.travis.yml
+++ b/.travis.yml
@ -12,14 +12,6 @@ notifications:
 cache: npm

 deploy:
-  - provider: releases
-    skip_cleanup: true
-    api_key:
-      secure: "txBAvszimYY9QqenZckMI+fC/qhnsD4zAUcULs/8D8rGaW7+lCGClV0MShh5T8o/aVbSRctFaHeEESGAuedxmETsQnkBe1XekE1WiXqADzcOp5rrfzIZruED50Zy9dafZGHNJVJax1J1BPb2GePhYg51WX/0OuKb0h5J5tZQvLXVHhtc5hNx5/0kzQNQpyjf8MA/MdZj/Qh5wPx8eKmdt+yTUfqFyzYwh7nE2U+KsHzC5CZdwGXnqZBsWqrNX+l35oFcAu7M7kIzm5RRugrqpmQQqMNDVka1cj3UW0VWve7V5IcnQCfRnat7wXKLPEmC/tBUB3LNRi4X+YKxkkcRaFStJeJw5sQhEK10Jso71p35u0X/AyNVQfzMZou1fFrJsqNGmlB9c/n4zHyepY6jOpEQDBiggvCcf0lvPrJmJvKW9+8HhVBlf9Pre1TmsAciw2jjIrClaTIF/vYk7C/ix37OcMVrijoH8yMOZEZLvpXJhLN/IMvLHyxduvO7ClzT4eWNSoduyZvYB8kGz5OIml7gCtSLQ0qM1We8u5lHTHhqFHChFlgK2F90NBaZV4U1DkxerQgY+EiCVrrDPHAcHmliKgzzYqBfOxsfCJ/odBwg+ASGBy+yLFpCTw5OB1Ap+fvwInz1eQQ0rTP44+24Kt0Nt4lJcFQp3bE+xyzUdk0="
-    on:
-        tags: true
-        all_branches: true
-
  - provider: script
    skip_cleanup: true
    script: bash -ex ./scripts/deploy_on_k8s.sh
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@ -1,7 +1,86 @@
-History
-=======
+### Changelog

-0.1.0 (Mar 31th, 2019)
-------------------------
+All notable changes to this project will be documented in this file. Dates are displayed in UTC.

-* First version
+Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
+
+#### [v0.1.2](https://github.com/oceanprotocol/commons-marketplace/compare/v0.1.1...v0.1.2)
+
+> 9 April 2019
+
+- search updates for Aquarius 0.2.2 [`#88`](https://github.com/oceanprotocol/commons-marketplace/pull/88)
+- Automatically deploy on new tags on k8s [`#87`](https://github.com/oceanprotocol/commons-marketplace/pull/87)
+- Feature/bumpversion [`#81`](https://github.com/oceanprotocol/commons-marketplace/pull/81)
+- Various fixes [`#83`](https://github.com/oceanprotocol/commons-marketplace/pull/83)
+- Added GH releases [`#80`](https://github.com/oceanprotocol/commons-marketplace/pull/80)
+- consume & faucet tweaks for Web3 cases [`4dcc6c8`](https://github.com/oceanprotocol/commons-marketplace/commit/4dcc6c831a015a1cf758218e9109f38b4f310d94)
+- mobile tweaks for search results and main menu [`5340df0`](https://github.com/oceanprotocol/commons-marketplace/commit/5340df0993eef5a35526d306f96bd020c0e64422)
+- Added GH templates [`ed7beb2`](https://github.com/oceanprotocol/commons-marketplace/commit/ed7beb295bebf6ebceabd656b0fe21abc57fcca3)
+
+#### [v0.1.1](https://github.com/oceanprotocol/commons-marketplace/compare/v0.1.0...v0.1.1)
+
+> 8 April 2019
+
+- strip HTML from meta page title [`#79`](https://github.com/oceanprotocol/commons-marketplace/pull/79)
+
+#### v0.1.0
+
+> 8 April 2019
+
+- render asset description with markdown [`#76`](https://github.com/oceanprotocol/commons-marketplace/pull/76)
+- Change sample data set/search to one w/ results [`#77`](https://github.com/oceanprotocol/commons-marketplace/pull/77)
+- analytics [`#74`](https://github.com/oceanprotocol/commons-marketplace/pull/74)
+- add initial about copy [`#73`](https://github.com/oceanprotocol/commons-marketplace/pull/73)
+- Make search more useful [`#50`](https://github.com/oceanprotocol/commons-marketplace/pull/50)
+- web2 and web3 [`#72`](https://github.com/oceanprotocol/commons-marketplace/pull/72)
+- Account popover tweaks [`#69`](https://github.com/oceanprotocol/commons-marketplace/pull/69)
+- fix dateCreated [`#70`](https://github.com/oceanprotocol/commons-marketplace/pull/70)
+- category fixes [`#67`](https://github.com/oceanprotocol/commons-marketplace/pull/67)
+- Change "i.e." to "e.g." in placeholders [`#66`](https://github.com/oceanprotocol/commons-marketplace/pull/66)
+- Feature/docker [`#62`](https://github.com/oceanprotocol/commons-marketplace/pull/62)
+- Style tweaks [`#59`](https://github.com/oceanprotocol/commons-marketplace/pull/59)
+- docker-compose + dockerfiles [`#61`](https://github.com/oceanprotocol/commons-marketplace/pull/61)
+- add basic SEO [`#60`](https://github.com/oceanprotocol/commons-marketplace/pull/60)
+- change brizo address [`#55`](https://github.com/oceanprotocol/commons-marketplace/pull/55)
+- rename to commons [`#51`](https://github.com/oceanprotocol/commons-marketplace/pull/51)
+- add remote config for Nile [`#48`](https://github.com/oceanprotocol/commons-marketplace/pull/48)
+- pass through faucet server response, error feedback [`#49`](https://github.com/oceanprotocol/commons-marketplace/pull/49)
+- Add date picker, ask for dateCreated [`#44`](https://github.com/oceanprotocol/commons-marketplace/pull/44)
+- More assets styling [`#36`](https://github.com/oceanprotocol/commons-marketplace/pull/36)
+- update file metadata structure [`#41`](https://github.com/oceanprotocol/commons-marketplace/pull/41)
+- bump packages [`#45`](https://github.com/oceanprotocol/commons-marketplace/pull/45)
+- switch to @oceanprotocol/typographies package [`#42`](https://github.com/oceanprotocol/commons-marketplace/pull/42)
+- dev instructions [`#39`](https://github.com/oceanprotocol/commons-marketplace/pull/39)
+- consume flow [`#32`](https://github.com/oceanprotocol/commons-marketplace/pull/32)
+- fix publishing nested categories in array [`#37`](https://github.com/oceanprotocol/commons-marketplace/pull/37)
+- More simple dev setup for client/server split [`#35`](https://github.com/oceanprotocol/commons-marketplace/pull/35)
+- Fix/frontend fixes [`#34`](https://github.com/oceanprotocol/commons-marketplace/pull/34)
+- add changelog [`#33`](https://github.com/oceanprotocol/commons-marketplace/pull/33)
+- Front-page tweaks & user asset list [`#19`](https://github.com/oceanprotocol/commons-marketplace/pull/19)
+- add invoice view [`#29`](https://github.com/oceanprotocol/commons-marketplace/pull/29)
+- root app->/client, microservice in /server [`#28`](https://github.com/oceanprotocol/commons-marketplace/pull/28)
+- Account & Faucet UI [`#25`](https://github.com/oceanprotocol/commons-marketplace/pull/25)
+- New publish flow [`#23`](https://github.com/oceanprotocol/commons-marketplace/pull/23)
+- package updates [`#27`](https://github.com/oceanprotocol/commons-marketplace/pull/27)
+- faucet request function [`#24`](https://github.com/oceanprotocol/commons-marketplace/pull/24)
+- search fix [`#21`](https://github.com/oceanprotocol/commons-marketplace/pull/21)
+- metadata fixes [`#17`](https://github.com/oceanprotocol/commons-marketplace/pull/17)
+- Asset styling [`#18`](https://github.com/oceanprotocol/commons-marketplace/pull/18)
+- Adding multiple files UI [`#16`](https://github.com/oceanprotocol/commons-marketplace/pull/16)
+- Feature/states flows [`#15`](https://github.com/oceanprotocol/commons-marketplace/pull/15)
+- Web3 messages [`#14`](https://github.com/oceanprotocol/commons-marketplace/pull/14)
+- fix form input props flow [`#13`](https://github.com/oceanprotocol/commons-marketplace/pull/13)
+- Base Layout [`#12`](https://github.com/oceanprotocol/commons-marketplace/pull/12)
+- Feature/leaner bootstrap [`#11`](https://github.com/oceanprotocol/commons-marketplace/pull/11)
+- Form components [`#7`](https://github.com/oceanprotocol/commons-marketplace/pull/7)
+- Switch to ESLint [`#10`](https://github.com/oceanprotocol/commons-marketplace/pull/10)
+- Feature/forms [`#9`](https://github.com/oceanprotocol/commons-marketplace/pull/9)
+- add travis, run tests on it [`#8`](https://github.com/oceanprotocol/commons-marketplace/pull/8)
+- add buttons and spinner [`#6`](https://github.com/oceanprotocol/commons-marketplace/pull/6)
+- global styling setup [`#5`](https://github.com/oceanprotocol/commons-marketplace/pull/5)
+- Prettier, stylelint, tslint, editorconfig, sitting in a tree [`#4`](https://github.com/oceanprotocol/commons-marketplace/pull/4)
+- initial import, react, routes, user context [`#3`](https://github.com/oceanprotocol/commons-marketplace/pull/3)
+- kick out prototyping stuff [`#58`](https://github.com/oceanprotocol/commons-marketplace/issues/58)
+- one dev interface for client & server [`7e42991`](https://github.com/oceanprotocol/commons-marketplace/commit/7e42991706f139a34e425dd7c20b28b4f55d77aa)
+- npm install [`07f6d22`](https://github.com/oceanprotocol/commons-marketplace/commit/07f6d22a36f0f253f9a6619912489679f62218da)
+- display published [`43d0847`](https://github.com/oceanprotocol/commons-marketplace/commit/43d0847d48ccf3f5796f27aae6cd179770c8a8d5)
--- a/README.md
+++ b/README.md
@ -2,7 +2,7 @@

 <h1 align="center">Commons</h1>

-> Marketplace front-end and backend server to explore, download, and publish open data sets.
+> 🏄‍♀️ Marketplace front-end and backend server to explore, download, and publish open data sets.
 > https://commons.oceanprotocol.com

 [![Build Status](https://travis-ci.com/oceanprotocol/commons.svg?token=3psqw6c8KMDqfdGQ2x6d&branch=master)](https://travis-ci.com/oceanprotocol/commons)
@ -14,19 +14,19 @@

 ---

-### 🦑🦑🦑 This marketplace is deployed under https://commons.oceanprotocol.com and can be used there. Feel free to [report any issues](https://github.com/oceanprotocol/commons/issues) you encounter. 🦑🦑🦑
+<h3 align="center">🦑🦑🦑<br />This marketplace is deployed under <a href="https://commons.oceanprotocol.com">commons.oceanprotocol.com</a> and can be used there. Feel free to <a href="https://github.com/oceanprotocol/commons/issues">report any issues</a> you encounter.<br />🦑🦑🦑</h3>

-If you're a developer and want to contribute to, or want to utilize this marketplace's code in your projects, then keep on reading.
+<p align="center">If you're a developer and want to contribute to, or want to utilize this marketplace's code in your projects, then keep on reading.</p>

 ---

 - [🏄 Get Started](#-get-started)
  - [🐳 Use with Barge](#-use-with-barge)
- [🛳 Production](#-production)
- [👩‍🔬 Testing](#-testing)
- [🎁 Contributing](#-contributing)
- [⬆️ Bumping version](#-bumping-version)
+- [<EFBFBD>‍🔬 Testing](#-testing)
 - [✨ Code Style](#-code-style)
+- [🛳 Production](#-production)
+- [⬆️ Releases](#️-releases)
+- [🎁 Contributing](#-contributing)
 - [🏛 License](#-license)

 This repo contains a client and a server, both written in TypeScript:
@ -60,16 +60,6 @@ cd barge

 Modify `./client/src/config/config.ts` to use those local connections.

-## 🛳 Production
-
-To create a production build of both, the client and the server, run from the root of the project:
-
-```bash
-npm run build
-```
-
-Builds the client for production to the `./client/build` folder, and the server into the `./server/dist` folder.
-
 ## 👩‍🔬 Testing

 ```bash
@ -78,19 +68,6 @@ npm test

 Launches the test runner in the interactive watch mode.

-## 🎁 Contributing
-
-See the page titled "[Ways to Contribute](https://docs.oceanprotocol.com/concepts/contributing/)" in the Ocean Protocol documentation.
-
-## ⬆️ Bumping version
-
-Use the `bumpversion.sh` script to bump the project version. You can execute the script using {major|minor|patch} as first argument to bump the version accordingly:
-  - To bump the patch version: `./bumpversion.sh patch`
-  - To bump the minor version: `./bumpversion.sh minor`
-  - To bump the major version: `./bumpversion.sh major`
-
-After that, you need to commit, push and git tag the commit if desired/needed.
-
 ## ✨ Code Style

 For linting and auto-formatting you can use from the root of the project:
@ -103,6 +80,40 @@ npm run lint
 npm run format
 ```

+## 🛳 Production
+
+To create a production build of both, the client and the server, run from the root of the project:
+
+```bash
+npm run build
+```
+
+Builds the client for production to the `./client/build` folder, and the server into the `./server/dist` folder.
+
+## ⬆️ Releases
+
+Running any release task does the following:
+
+- bumps the project version
+- creates a Git tag
+- updates CHANGELOG.md file with commit messages
+- commits and pushes everything
+- creates a GitHub release with commit messages as description
+
+You can execute the script using {major|minor|patch} as first argument to bump the version accordingly:
+
+- To bump a patch version: `npm run release`
+- To bump a minor version: `npm run release-minor`
+- To bump a major version: `npm run release-major`
+
+By creating the Git tag with these tasks, Travis will trigger a new Kubernetes deployment automatically aftr a successful tag build.
+
+For the GitHub releases steps a GitHub personal access token, exported as `GITHUB_TOKEN` is required. [Setup](https://github.com/release-it/release-it#github-releases)
+
+## 🎁 Contributing
+
+See the page titled "[Ways to Contribute](https://docs.oceanprotocol.com/concepts/contributing/)" in the Ocean Protocol documentation.
+
 ## 🏛 License

 ```text
--- a/bumpversion.sh
+++ b/bumpversion.sh
@ -1,36 +0,0 @@
-#!/bin/bash
-
-set -x
-set -e
-
-usage(){
-  echo "Usage: $0 {major|minor|patch} [--tag]"
-  exit 1
-}
-
-if ! [ -x "$(command -v bumpversion)" ]; then
-  echo 'Error: bumpversion is not installed.' >&2
-  exit 1
-elif ! git diff-index --quiet HEAD -- >/dev/null 2>&1; then
-  echo 'There are local changes in your the git repository. Please commit or stash them before bumping version.' >&2
-  exit 1
-fi
-
-if [ "$#" -lt 1 ]; then
-    echo "Illegal number of parameters"
-    usage
-elif [[ $1 != 'major' && $1 != 'minor' && $1 != 'patch' ]]; then
-    echo 'First argument must be {major|minor|patch}'
-    usage
-fi
-
-if [[ $2 == '--tag' ]]; then
-  if git branch --contains $(git rev-parse --verify HEAD) | grep -E 'master'; then
-    bumpversion --tag --commit $1
-  else
-    echo "Only master tags can be tagged"
-    exit 1
-  fi
-else
-  bumpversion $1
-fi
--- a/library.json
+++ b/library.json
@ -15,7 +15,7 @@
    },
    {
      "name": "aquarius",
-      "version": "~0.2.1"
+      "version": "~0.2.2"
    },
    {
      "name": "squid-js",
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@ -2,7 +2,6 @@
  "name": "commons",
  "description": "Ocean Protocol marketplace to explore, download, and publish open data sets.",
  "version": "0.1.2",
-  "private": true,
  "license": "Apache-2.0",
  "scripts": {
    "install": "./scripts/install.sh",
@ -15,12 +14,18 @@
    "lint:css": "stylelint --ignore-path .gitignore './**/*.{css,scss}'",
    "lint:js": "eslint --ignore-path .gitignore --ignore-path .prettierignore --ext .ts,.tsx .",
    "lint:fix": "eslint --fix --ignore-path .gitignore --ignore-path .prettierignore --ext .ts,.tsx .",
-    "lint": "npm run lint:js && npm run lint:css"
+    "lint": "npm run lint:js && npm run lint:css",
+    "release": "./node_modules/release-it/bin/release-it.js --src.tagName='v%s' --github.release --non-interactive --no-npm.publish",
+    "release-minor": "./node_modules/release-it/bin/release-it.js minor --src.tagName='v%s' --github.release --non-interactive --no-npm.publish",
+    "release-major": "./node_modules/release-it/bin/release-it.js major --src.tagName='v%s' --github.release --non-interactive --no-npm.publish",
+    "changelog": "auto-changelog",
+    "beforeStage": "npm run changelog"
  },
  "dependencies": {},
  "devDependencies": {
    "@typescript-eslint/eslint-plugin": "^1.4.2",
    "@typescript-eslint/parser": "^1.4.2",
+    "auto-changelog": "^1.12.0",
    "concurrently": "^4.1.0",
    "eslint": "5.12.0",
    "eslint-config-oceanprotocol": "^1.3.0",
@ -28,6 +33,7 @@
    "eslint-plugin-prettier": "^3.0.1",
    "prettier": "^1.16.4",
    "prettier-stylelint": "^0.4.2",
+    "release-it": "^10.4.0",
    "stylelint": "^9.10.1",
    "stylelint-config-bigchaindb": "^1.2.1",
    "stylelint-config-css-modules": "^1.3.0",