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 6bc9707..e8deb77 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,9 @@ # Changelog -_**If you are upgrading:** please see [`UPGRADING.md`](UPGRADING.md)._ - ## [6.0.0] - 2021-04-17 +_If you are upgrading: please see [`UPGRADING.md`](UPGRADING.md)._ + ### Changed - **Breaking:** modernize syntax and bump `standard` ([Level/community#98](https://github.com/Level/community/issues/98)) ([`4770d17`](https://github.com/Level/packager/commit/4770d17)) (Vincent Weevers) @@ -67,6 +67,8 @@ _**If you are upgrading:** please see [`UPGRADING.md`](UPGRADING.md)._ ## [5.0.0] - 2018-12-27 +_If you are upgrading: please see [`UPGRADING.md`](UPGRADING.md)._ + ### Changed - Upgrade `encoding-down` from `~5.0.0` to `^6.0.0` ([#80](https://github.com/Level/packager/issues/80), [#81](https://github.com/Level/packager/issues/81)) ([**@vweevers**](https://github.com/vweevers)) @@ -99,6 +101,8 @@ _**If you are upgrading:** please see [`UPGRADING.md`](UPGRADING.md)._ ## [4.0.0] - 2018-06-13 +_If you are upgrading: please see [`UPGRADING.md`](UPGRADING.md)._ + ### Changed - Rewrite `test.js` to test `level-packager` api ([**@ralphtheninja**](https://github.com/ralphtheninja)) @@ -115,6 +119,8 @@ _**If you are upgrading:** please see [`UPGRADING.md`](UPGRADING.md)._ ## [3.0.0] - 2018-05-23 +_If you are upgrading: please see [`UPGRADING.md`](UPGRADING.md)._ + ### Added - Add node 10 to Travis ([**@ralphtheninja**](https://github.com/ralphtheninja)) @@ -347,9 +353,9 @@ _**If you are upgrading:** please see [`UPGRADING.md`](UPGRADING.md)._ ## [0.17.0] - 2013-10-09 -:seedling: Initial release. +_This changelog is ordered by semver-version, but the first few releases here did not use semver-valid tags._ -**Historical Note** This changelog is ordered by semver-version, but the first few releases here did not use semver-valid tags. +:seedling: Initial release. ## [0.17.0-5] - 2013-10-12 @@ -389,78 +395,78 @@ _**If you are upgrading:** please see [`UPGRADING.md`](UPGRADING.md)._ - Remove `tape` from devDependencies, allow callers to pass in custom test function ([**@rvagg**](https://github.com/rvagg)) -[6.0.0]: https://github.com/Level/packager/compare/v5.1.1...v6.0.0 +[6.0.0]: https://github.com/Level/packager/releases/tag/v6.0.0 -[5.1.1]: https://github.com/Level/packager/compare/v5.1.0...v5.1.1 +[5.1.1]: https://github.com/Level/packager/releases/tag/v5.1.1 -[5.1.0]: https://github.com/Level/packager/compare/v5.0.3...v5.1.0 +[5.1.0]: https://github.com/Level/packager/releases/tag/v5.1.0 -[5.0.3]: https://github.com/Level/packager/compare/v5.0.2...v5.0.3 +[5.0.3]: https://github.com/Level/packager/releases/tag/v5.0.3 -[5.0.2]: https://github.com/Level/packager/compare/v5.0.1...v5.0.2 +[5.0.2]: https://github.com/Level/packager/releases/tag/v5.0.2 -[5.0.1]: https://github.com/Level/packager/compare/v5.0.0...v5.0.1 +[5.0.1]: https://github.com/Level/packager/releases/tag/v5.0.1 -[5.0.0]: https://github.com/Level/packager/compare/v4.0.1...v5.0.0 +[5.0.0]: https://github.com/Level/packager/releases/tag/v5.0.0 -[4.0.1]: https://github.com/Level/packager/compare/v4.0.0...v4.0.1 +[4.0.1]: https://github.com/Level/packager/releases/tag/v4.0.1 -[4.0.0]: https://github.com/Level/packager/compare/v3.1.0...v4.0.0 +[4.0.0]: https://github.com/Level/packager/releases/tag/v4.0.0 -[3.1.0]: https://github.com/Level/packager/compare/v3.0.0...v3.1.0 +[3.1.0]: https://github.com/Level/packager/releases/tag/v3.1.0 -[3.0.0]: https://github.com/Level/packager/compare/v2.1.1...v3.0.0 +[3.0.0]: https://github.com/Level/packager/releases/tag/v3.0.0 -[2.1.1]: https://github.com/Level/packager/compare/v2.1.0...v2.1.1 +[2.1.1]: https://github.com/Level/packager/releases/tag/v2.1.1 -[2.1.0]: https://github.com/Level/packager/compare/v2.0.2...v2.1.0 +[2.1.0]: https://github.com/Level/packager/releases/tag/v2.1.0 -[2.0.2]: https://github.com/Level/packager/compare/v2.0.1...v2.0.2 +[2.0.2]: https://github.com/Level/packager/releases/tag/v2.0.2 -[2.0.1]: https://github.com/Level/packager/compare/v2.0.0...v2.0.1 +[2.0.1]: https://github.com/Level/packager/releases/tag/v2.0.1 -[2.0.0]: https://github.com/Level/packager/compare/v2.0.0-rc3...v2.0.0 +[2.0.0]: https://github.com/Level/packager/releases/tag/v2.0.0 -[2.0.0-rc3]: https://github.com/Level/packager/compare/v2.0.0-rc2...v2.0.0-rc3 +[2.0.0-rc3]: https://github.com/Level/packager/releases/tag/v2.0.0-rc3 -[2.0.0-rc2]: https://github.com/Level/packager/compare/v2.0.0-rc1...v2.0.0-rc2 +[2.0.0-rc2]: https://github.com/Level/packager/releases/tag/v2.0.0-rc2 -[2.0.0-rc1]: https://github.com/Level/packager/compare/v1.2.1...v2.0.0-rc1 +[2.0.0-rc1]: https://github.com/Level/packager/releases/tag/v2.0.0-rc1 -[1.2.1]: https://github.com/Level/packager/compare/v1.2.0...v1.2.1 +[1.2.1]: https://github.com/Level/packager/releases/tag/v1.2.1 -[1.2.0]: https://github.com/Level/packager/compare/v1.1.0...v1.2.0 +[1.2.0]: https://github.com/Level/packager/releases/tag/v1.2.0 -[1.1.0]: https://github.com/Level/packager/compare/v1.0.0...v1.1.0 +[1.1.0]: https://github.com/Level/packager/releases/tag/v1.1.0 -[1.0.0]: https://github.com/Level/packager/compare/v1.0.0-0...v1.0.0 +[1.0.0]: https://github.com/Level/packager/releases/tag/v1.0.0 -[1.0.0-0]: https://github.com/Level/packager/compare/v0.19.7...v1.0.0-0 +[1.0.0-0]: https://github.com/Level/packager/releases/tag/v1.0.0-0 -[0.19.7]: https://github.com/Level/packager/compare/v0.19.6...v0.19.7 +[0.19.7]: https://github.com/Level/packager/releases/tag/v0.19.7 -[0.19.6]: https://github.com/Level/packager/compare/v0.19.5...v0.19.6 +[0.19.6]: https://github.com/Level/packager/releases/tag/v0.19.6 -[0.19.5]: https://github.com/Level/packager/compare/v0.19.4...v0.19.5 +[0.19.5]: https://github.com/Level/packager/releases/tag/v0.19.5 -[0.19.4]: https://github.com/Level/packager/compare/v0.19.3...v0.19.4 +[0.19.4]: https://github.com/Level/packager/releases/tag/v0.19.4 -[0.19.3]: https://github.com/Level/packager/compare/v0.19.2...v0.19.3 +[0.19.3]: https://github.com/Level/packager/releases/tag/v0.19.3 -[0.19.2]: https://github.com/Level/packager/compare/v0.19.1...v0.19.2 +[0.19.2]: https://github.com/Level/packager/releases/tag/v0.19.2 -[0.19.1]: https://github.com/Level/packager/compare/v0.19.0...v0.19.1 +[0.19.1]: https://github.com/Level/packager/releases/tag/v0.19.1 -[0.19.0]: https://github.com/Level/packager/compare/0.18.0...v0.19.0 +[0.19.0]: https://github.com/Level/packager/releases/tag/v0.19.0 -[0.18.0]: https://github.com/Level/packager/compare/0.17.0...0.18.0 +[0.18.0]: https://github.com/Level/packager/releases/tag/0.18.0 -[0.17.0]: https://github.com/Level/packager/compare/0.17.0-5...0.17.0 +[0.17.0]: https://github.com/Level/packager/releases/tag/0.17.0 -[0.17.0-5]: https://github.com/Level/packager/compare/0.17.0-4...0.17.0-5 +[0.17.0-5]: https://github.com/Level/packager/releases/tag/0.17.0-5 -[0.17.0-4]: https://github.com/Level/packager/compare/0.17.0-3...0.17.0-4 +[0.17.0-4]: https://github.com/Level/packager/releases/tag/0.17.0-4 -[0.17.0-3]: https://github.com/Level/packager/compare/0.17.0-2...0.17.0-3 +[0.17.0-3]: https://github.com/Level/packager/releases/tag/0.17.0-3 -[0.17.0-2]: https://github.com/Level/packager/compare/0.17.0-1...0.17.0-2 +[0.17.0-2]: https://github.com/Level/packager/releases/tag/0.17.0-2 diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md deleted file mode 100644 index 64e8472..0000000 --- a/CONTRIBUTORS.md +++ /dev/null @@ -1,12 +0,0 @@ -# Contributors - -| Name | GitHub | Social | -| :------------------- | :----------------------------------------------------- | :-------------------------------------------------------------- | -| **Lars-Magnus Skog** | [**@ralphtheninja**](https://github.com/ralphtheninja) | [**@ralph@social.weho.st**](https://social.weho.st/@ralph) | -| **Vincent Weevers** | [**@vweevers**](https://github.com/vweevers) | [**@vweevers@twitter**](https://twitter.com/vweevers) | -| **Julian Gruber** | [**@juliangruber**](https://github.com/juliangruber) | [**@juliangruber@twitter**](https://twitter.com/juliangruber) | -| **Rod Vagg** | [**@rvagg**](https://github.com/rvagg) | [**@rvagg@twitter**](https://twitter.com/rvagg) | -| **Alex Potsides** | | | -| **Andrew Kelley** | [**@andrewrk**](https://github.com/andrewrk) | | -| **Deian Stefan** | [**@deian**](https://github.com/deian) | | -| **Matteo Collina** | [**@mcollina**](https://github.com/mcollina) | [**@matteocollina@twitter**](https://twitter.com/matteocollina) | diff --git a/LICENSE.md b/LICENSE similarity index 92% rename from LICENSE.md rename to LICENSE index 7dd1735..1bb7b70 100644 --- a/LICENSE.md +++ b/LICENSE @@ -1,6 +1,6 @@ -# The MIT License (MIT) +The MIT License (MIT) -**Copyright © 2013-present [Contributors](CONTRIBUTORS.md).** +Copyright © 2013 The contributors to level-packager. 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 18c3a1c..0f44bb8 100644 --- a/README.md +++ b/README.md @@ -3,15 +3,13 @@ > `levelup` package helper for distributing with an `abstract-leveldown` store. [![level badge][level-badge]](https://github.com/Level/awesome) -[![npm](https://img.shields.io/npm/v/level-packager.svg?label=&logo=npm)](https://www.npmjs.com/package/level-packager) +[![npm](https://img.shields.io/npm/v/level-packager.svg)](https://www.npmjs.com/package/level-packager) [![Node version](https://img.shields.io/node/v/level-packager.svg)](https://www.npmjs.com/package/level-packager) -[![Test](https://github.com/Level/packager/actions/workflows/test.yml/badge.svg)](https://github.com/Level/packager/actions/workflows/test.yml) -[![Coverage Status](https://codecov.io/gh/Level/packager/branch/master/graph/badge.svg)](https://codecov.io/gh/Level/packager) - -[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) -[![npm](https://img.shields.io/npm/dm/level-packager.svg?label=dl)](https://www.npmjs.com/package/level-packager) -[![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/packager/Test?label=test)](https://github.com/Level/packager/actions/workflows/test.yml) +[![Coverage](https://img.shields.io/codecov/c/github/Level/packager?label=&logo=codecov&logoColor=fff)](https://codecov.io/gh/Level/packager) +[![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) ## API @@ -28,7 +26,7 @@ For example use-cases, see: Also available is a _test.js_ file that can be used to verify that the user-package works as expected. -**If you are upgrading:** please see [`UPGRADING.md`](UPGRADING.md). +_If you are upgrading: please see [`UPGRADING.md`](UPGRADING.md)._ ## Contributing @@ -40,18 +38,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) © 2013-present [Contributors](CONTRIBUTORS.md). +[MIT](LICENSE) [level-badge]: https://leveljs.org/img/badge.svg diff --git a/package.json b/package.json index 96172fb..6b35502 100644 --- a/package.json +++ b/package.json @@ -16,8 +16,6 @@ "abstract", "level-packager.js", "CHANGELOG.md", - "CONTRIBUTORS.md", - "LICENSE.md", "UPGRADING.md" ], "dependencies": { @@ -29,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/packager.git"