From 7ba0f6571713b7712469c11f2c19e407e7001d27 Mon Sep 17 00:00:00 2001 From: Vincent Weevers Date: Thu, 4 Nov 2021 18:52:34 +0100 Subject: [PATCH] Update metadata and add release workflow --- .github/workflows/release.yml | 17 +++++++++++++++++ CHANGELOG.md | 14 ++++++++++---- LICENSE.md => LICENSE | 4 ++-- README.md | 29 ++++++++++------------------- example.js | 14 -------------- package.json | 6 +----- 6 files changed, 40 insertions(+), 44 deletions(-) create mode 100644 .github/workflows/release.yml rename LICENSE.md => LICENSE (90%) delete mode 100644 example.js diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..53cd4bd --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,17 @@ +name: Release +on: + push: + tags: ['*'] +permissions: + contents: write +jobs: + release: + name: Release + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + - name: Create GitHub release + uses: docker://antonyurchenko/git-release:v4 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/CHANGELOG.md b/CHANGELOG.md index d87dde2..4e1a832 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,8 @@ ## [3.0.0] - 2021-04-08 +_If you are upgrading: please see [`UPGRADING.md`](UPGRADING.md)._ + ### Changed - **Breaking:** modernize syntax and bump standard ([`dd37269`](https://github.com/Level/concat-iterator/commit/dd37269)) ([Level/community#98](https://github.com/Level/community/issues/98)) (Vincent Weevers). @@ -23,6 +25,8 @@ ## [2.0.0] - 2018-06-27 +_If you are upgrading: please see [`UPGRADING.md`](UPGRADING.md)._ + ### Changed - Detect end by checking key and value ([**@vweevers**](https://github.com/vweevers)) @@ -38,12 +42,14 @@ - Add `homepage` and `repository` to `package.json` ([**@ralphtheninja**](https://github.com/ralphtheninja)) - Add `UPGRADING.md` ([**@ralphtheninja**](https://github.com/ralphtheninja)) -## 1.0.0 - 2018-06-24 +## [1.0.0] - 2018-06-24 :seedling: Initial release. -[3.0.0]: https://github.com/Level/concat-iterator/compare/v2.0.1...v3.0.0 +[3.0.0]: https://github.com/Level/concat-iterator/releases/tag/v3.0.0 + +[2.0.1]: https://github.com/Level/concat-iterator/releases/tag/v2.0.1 -[2.0.1]: https://github.com/Level/concat-iterator/compare/v2.0.0...v2.0.1 +[2.0.0]: https://github.com/Level/concat-iterator/releases/tag/v2.0.0 -[2.0.0]: https://github.com/Level/concat-iterator/compare/v1.0.0...v2.0.0 +[1.0.0]: https://github.com/Level/concat-iterator/releases/tag/v1.0.0 diff --git a/LICENSE.md b/LICENSE similarity index 90% rename from LICENSE.md rename to LICENSE index 485df49..7280665 100644 --- a/LICENSE.md +++ b/LICENSE @@ -1,6 +1,6 @@ -# The MIT License (MIT) +The MIT License (MIT) -**Copyright © 2018-present Lars-Magnus Skog and contributors.** +Copyright © 2018 Lars-Magnus Skog and the contributors to level-concat-iterator. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 9d480b7..37ad8c0 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,15 @@ # level-concat-iterator -> Concatenate entries from an iterator into an array. +**Concatenate entries from an iterator into an array.** [![level badge][level-badge]](https://github.com/Level/awesome) -[![npm](https://img.shields.io/npm/v/level-concat-iterator.svg?label=&logo=npm)](https://www.npmjs.com/package/level-concat-iterator) +[![npm](https://img.shields.io/npm/v/level-concat-iterator.svg)](https://www.npmjs.com/package/level-concat-iterator) [![Node version](https://img.shields.io/node/v/level-concat-iterator.svg)](https://www.npmjs.com/package/level-concat-iterator) -[![Test](https://github.com/Level/concat-iterator/actions/workflows/test.yml/badge.svg)](https://github.com/Level/concat-iterator/actions/workflows/test.yml) -[![codecov](https://codecov.io/gh/Level/concat-iterator/branch/master/graph/badge.svg)](https://codecov.io/gh/Level/concat-iterator) -[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) -[![npm](https://img.shields.io/npm/dm/level-concat-iterator.svg?label=dl)](https://www.npmjs.com/package/level-concat-iterator) -[![Backers on Open Collective](https://opencollective.com/level/backers/badge.svg?color=orange)](#backers) -[![Sponsors on Open Collective](https://opencollective.com/level/sponsors/badge.svg?color=orange)](#sponsors) +[![Test](https://img.shields.io/github/workflow/status/Level/concat-iterator/Test?label=test)](https://github.com/Level/concat-iterator/actions/workflows/test.yml) +[![Coverage](https://img.shields.io/codecov/c/github/Level/supports?label=&logo=codecov&logoColor=fff)](https://codecov.io/gh/Level/supports) +[![Standard](https://img.shields.io/badge/standard-informational?logo=javascript&logoColor=fff)](https://standardjs.com) +[![Common Changelog](https://common-changelog.org/badge.svg)](https://common-changelog.org) +[![Donate](https://img.shields.io/badge/donate-orange?logo=open-collective&logoColor=fff)](https://opencollective.com/level) ## Usage @@ -39,7 +38,7 @@ await db.put('foo', 'bar') const entries = await concat(db.iterator()) ``` -**If you are upgrading:** please see [`UPGRADING.md`](UPGRADING.md). +_If you are upgrading: please see [`UPGRADING.md`](UPGRADING.md)._ ## API @@ -57,18 +56,10 @@ See the [Contribution Guide](https://github.com/Level/community/blob/master/CONT ## Donate -To sustain [`Level`](https://github.com/Level) and its activities, become a backer or sponsor on [Open Collective](https://opencollective.com/level). Your logo or avatar will be displayed on our 28+ [GitHub repositories](https://github.com/Level) and [npm](https://www.npmjs.com/) packages. 💖 - -### Backers - -[![Open Collective backers](https://opencollective.com/level/backers.svg?width=890)](https://opencollective.com/level) - -### Sponsors - -[![Open Collective sponsors](https://opencollective.com/level/sponsors.svg?width=890)](https://opencollective.com/level) +Support us with a monthly donation on [Open Collective](https://opencollective.com/level) and help us continue our work. ## License -[MIT](LICENSE.md) © 2018-present Lars-Magnus Skog and contributors. +[MIT](LICENSE) [level-badge]: https://leveljs.org/img/badge.svg diff --git a/example.js b/example.js deleted file mode 100644 index ff1a682..0000000 --- a/example.js +++ /dev/null @@ -1,14 +0,0 @@ -const level = require('level') -const concat = require('.') - -const db = level('./db') - -db.put('foo', 'bar', function (err) { - if (err) throw err - - concat(db.iterator(), function (err, entries) { - if (err) throw err - - console.log(entries) - }) -}) diff --git a/package.json b/package.json index 1a8fe3b..8390c2d 100644 --- a/package.json +++ b/package.json @@ -16,7 +16,7 @@ "files": [ "index.js", "CHANGELOG.md", - "LICENSE.md", + "LICENSE", "UPGRADING.md" ], "dependencies": { @@ -27,14 +27,10 @@ "airtap-playwright": "^1.0.1", "dependency-check": "^3.3.0", "hallmark": "^3.1.0", - "level-community": "^3.0.0", "nyc": "^15.1.0", "standard": "^16.0.3", "tape": "^5.0.1" }, - "hallmark": { - "community": "level-community" - }, "repository": { "type": "git", "url": "https://github.com/Level/concat-iterator.git"