Skip to content

Commit

Permalink
v2.3.0 - boundation, changelog, version bump
Browse files Browse the repository at this point in the history
  • Loading branch information
balupton committed Aug 6, 2020
1 parent 5f425a6 commit 5188173
Show file tree
Hide file tree
Showing 19 changed files with 1,859 additions and 3,607 deletions.
1 change: 0 additions & 1 deletion .babelrc

This file was deleted.

6 changes: 3 additions & 3 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 2018 January 24
# 2018 September 26
# https://github.com/bevry/base

root = true
Expand All @@ -18,9 +18,9 @@ indent_size = 4
indent_style = space
indent_size = 4

[{*.json,*.yml,*.bowerrc,*.babelrc}]
[{*.json,*.lsrules,*.yml,*.bowerrc,*.babelrc}]
indent_style = space
indent_size = 2

[*.json]
[{*.json,*.lsrules}]
insert_final_newline = true
6 changes: 6 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
github: [balupton]
patreon: bevry
open_collective: bevry
ko_fi: balupton
liberapay: bevry
custom: ['https://bevry.me/fund']
6 changes: 6 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
version: 2
updates:
- package-ecosystem: npm
directory: /
schedule:
interval: weekly
49 changes: 32 additions & 17 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,41 +1,56 @@
# 2017 April 12
# 2020 June 3
# https://github.com/bevry/base

# System Files
**/.DS_Store

# Temp Files
yarn.lock
**/.docpad.db
**/out.*
**/*.log
**/*.cpuprofile
**/*.heapsnapshot

# Build Files
# Editor Files
.c9/
.vscode/

# Yarn Files
.yarn/*
!.yarn/releases
!.yarn/plugins
!.yarn/sdks
!.yarn/versions
.pnp.*
.pnp/

# Private Files
.env
.idea
.cake_task_cache

# Build Caches
build/
components/
bower_components/
node_modules/
out/
*output/
.next/

# -------------------------------------
# CDN Inclusions, Git Exclusions

# Build Outputs
**/out.*
**/*.out.*
**/out/
**/output/
*compiled*
edition*/
coffeejs/
coffee/
es5/
es2015/
esnext/
docs/

# Editor Caches
.c9/
.vscode/

# Private Files
.env
.idea
.cake_task_cache


# =====================================
# CUSTOM

Expand Down
25 changes: 19 additions & 6 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# 2017 April 3
# 2020 May 5
# https://github.com/bevry/base

# System Files
**/.DS_Store

# Temp Files
yarn.lock
**/.docpad.db
**/out.*
**/*.log
**/*.cpuprofile
**/*.heapsnapshot
Expand All @@ -13,14 +14,25 @@ yarn.lock
.c9/
.vscode/

# Build Files
# Private Files
.env
.idea
.cake_task_cache

# Build Caches
build/
components/
bower_components/
node_modules/
.pnp/
.pnp.js

# Private Files
.env
# Ecosystem Files
.dependabout
.github

# -------------------------------------
# CDN Inclusions, Package Exclusions

# Documentation Files
docs/
Expand All @@ -33,6 +45,7 @@ HISTORY.md
web/
**/example*
**/test*
.babelrc*
.editorconfig
.eslintrc*
.jshintrc
Expand Down
39 changes: 18 additions & 21 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,31 +1,28 @@
version: ~> 1.0
sudo: false
language: node_js
node_js:
- '0.8'
- '0.10'
- '0.12'
- '4'
- '6'
- '8'
- '10'
- '10'
- '12'
- '13'
- '14'
matrix:
fast_finish: true
allow_failures:
- node_js: '0.8'
- node_js: '0.10'
cache:
directories:
- "$HOME/.npm"
- "$HOME/.yarn-cache"
allow_failures: []
cache: npm
install:
- eval "$(curl -fsSL https://raw.githubusercontent.com/bevry/awesome-travis/1ec050bc004d0e2161cb5286c247850d24aecc02/scripts/node-install.bash)"
- >-
eval "$(curl -fsSL
https://raw.githubusercontent.com/bevry/awesome-travis/master/scripts/node-install.bash)"
before_script:
- eval "$(curl -fsSL https://raw.githubusercontent.com/bevry/awesome-travis/1ec050bc004d0e2161cb5286c247850d24aecc02/scripts/node-verify.bash)"
- >-
eval "$(curl -fsSL
https://raw.githubusercontent.com/bevry/awesome-travis/master/scripts/node-verify.bash)"
after_success:
- eval "$(curl -fsSL https://raw.githubusercontent.com/bevry/awesome-travis/1ec050bc004d0e2161cb5286c247850d24aecc02/scripts/node-publish.bash)"
- >-
eval "$(curl -fsSL
https://raw.githubusercontent.com/bevry/awesome-travis/master/scripts/node-publish.bash)"
notifications:
slack:
secure: pq2HIznBYNhV2MFoS1x9+4M3Kt+KZVWLjco6ecU0m1T66NMwmwh5cJs2sKH7brsaia3ok9otKLdY2h88VA3P4vJdtf5bpl31RcyYHXJUfi8hmL+oQ9dPIFIkJ7aZ+Qt/sBEg2rcRAqLHU8mnjLlHExkKkB4sa5Pc45TAXjL4pbKFAmGjvAyPFVl/BnfJahJvmhqAvTfQarAa0Ra3HbxNLYDWWvlUxB6WRyjSY+qme8FJ9N8kU/7IDPFzQ7pazfA9kM/rfrtilbDOnyLUvyH7fs7oiRevMJtlfXVBKqNYHI7vrjwPfXS3plMfRax/7SkmIknZpESZOlNx2l+LHmbcjYfzDmcqsYP9KknjdX4QOZrM3hPwYdmPUpMJvGqkveek3Sc3YP9LgsaF7ogR3X+VodgfK0SizEI7oTcY0GIG8A9iukvhdHfqOGJobhTeaiXZaAbZNKJmzJit0FQ9pXGyDE5t34GwY1Gnp0llwkhyUX+vGHcGu0GWUyErpkRjmzEhX51khU2yCYFUzo2aoYoUv+9B8nzT9GOH2MphFXNH0KOLsomtlP/XJL3JchKt6WtTMGxNa16F/j5HyNNa4IhFbfs5FI3wy5fbjLzuOb/IrQaPEjrOoXU/OvX5zmS5OWzCCb/EKh666Jqml6w39X35jQq4jxQ/+D16CBgM4Ro8AXY=
email:
recipients:
secure: vz63hdmi8KcbH1Z7KA3j8k8oogHSL6SnjGrXMxS4lmJCjOCwfQ2hj8mSLIRrqSaesxp7yjljJ8H4DzyB+GvOrfM+obnmKg14ZyHTtahWHHnYEJocX3rLs8uqpeN6BJxRj6eBTzj6Lg0cu+8WhzKJP5N5tqPeWJ39rht9sKxuxT7vxE/h1BfumLrhlf8y+PSqmJhkJdb0sBdMnMmPALSfkhLAcygep6672UuNxk5N/Qb9c/q/X1ua3VQu9J0hRNYiquLbIBrIOa92PM2xK+Ax/u2bi2nYJe+fIkUUzrV0B/PmfJbhrDc2hcR7q1PRmm+fo+0P9/cglhENX78E7J265hNx/epX1DFBBJ/2MIvi80QuDyEt7QvU2+KgII6tBJ+bzyfG1d/HW6JDA2dkfj9RxuLCnTuEfVr6mRAHjtWJ/Q9UQ0vHBWdgsMMBpiRhM/7zW7jAJ5m5gsguoi3HqGtJYUcgDnGr3OnXbS4eNtl5C07sbCqT/NKuQxonFRaGCJd1OwaUDPz3QQ6jh1EDqbOr1Tj+h5rLwzHQU9RDZVuaIjUdj9rZtKah3u105pxuL9rZEarQ8S+bDTa1n8Npz+kNhPN0OtSC8TQowV+DiOZNvuJLiBfryJ0X+zGRqRQ06NWNIUKnE7ZxCNoaBaXP6trTRQ9L0ITE5xxy2y0YAgktIYg=
recipients: >-
0MhnNrkFaQ3pVyPKaktjoGvDzN2/KWu30yiYbZxNEk5E1CPbz6DKDtpdAVLk/RjQocSjRyjE/D7daKqUD1FU1zOJCsLtqinMfC3/u3PQaS6wj1q9PJFkIZFqXavdlnckErfQCM0CIgeg57lfPbTFApA9s7r5dJpEQjWU0JEepJ9BqwNahy+p1qCsGnajTYRvEjFutkf6Lim3q21Elvd71GOe1TOsCX4sVEIptVeGHdrxC3FPiCnv7aziUoQTSoPitIDntFobSKRBU/tz4OOhZELuxSRWFxkv5CZNfTKV9eoYHRjlOfVGxGoep1HHQb+vybeeKYY5UFVbvcSt5uK2XqNm1x3rpDkr6+HbLOGYdfWzSJfFrEnzNk35/7JClzjkpBAqbYnpk0AlmmMd3SFNmABjlyQQk2M74pUIPORN+JrnMCR60VjTVJuo9UDGkjJe6dVA7DIjhD5WMIkGpGOOnLCtpREyMrVa5v8p85SA3RJCNzv4HawUkML8y2dAVTLoqz8uJjijLH6u4LrcyzwUSrmaiCgStrNZ7/Q4Jgl8WQN59bpNY8X8w6T9xNtx4cs89GMTJwO4Lkx91fAQrqY0U20RSrfuBT8NPaC8ew3IbCFCZ5LrCS7kwe4kt3Brm33ctp1SZHmo9CTAWkVm99mvGU74wF9QhfVd7ZYU70Q8TcM=
38 changes: 16 additions & 22 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
2017 August 25
2020 March 26
https://github.com/bevry/base
-->

Expand All @@ -9,56 +9,52 @@ https://github.com/bevry/base

We offer support through our [Official Support Channels](https://bevry.me/support). Do not use GitHub Issues for support, your issue will be closed.


## Contribute

Our [Contributing Guide](https://bevry.me/contribute) contains useful tips and suggestions for how to contribute to this project, it's worth the read.


## Development

### Setup

1. Install [Node.js](https://learn.bevry.me/node/install)
1. [Install Node.js](https://bevry.me/install/node)

1. Fork the project and clone your fork - [guide](https://help.github.com/articles/fork-a-repo/)

1. Setup the project for development

``` bash
```bash
npm run our:setup
```


### Developing

1. Compile changes

``` bash
```bash
npm run our:compile
```

1. Run tests

``` bash
```bash
npm test
```


### Publishing

Follow these steps in order to implement your changes/improvements into your desired project:


#### Preparation

1. Make sure your changes are on their own branch that is branched off from master.

1. You can do this by: `git checkout master; git checkout -b your-new-branch`
1. And push the changes up by: `git push origin your-new-branch`

1. Ensure all tests pass:

``` bash
```bash
npm test
```

Expand All @@ -70,7 +66,6 @@ Follow these steps in order to implement your changes/improvements into your des
npm run our:release:prepare
```


#### Pull Request

To send your changes for the project owner to merge in:
Expand All @@ -79,38 +74,37 @@ To send your changes for the project owner to merge in:
1. When submitting, if the original project has a `dev` or `integrate` branch, use that as the target branch for your pull request instead of the default `master`
1. By submitting a pull request you agree for your changes to have the same license as the original plugin


#### Publish

To publish your changes as the project owner:

1. Switch to the master branch:

``` bash
```bash
git checkout master
```

1. Merge in the changes of the feature branch (if applicable)

1. Increment the version number in the `package.json` file according to the [semantic versioning](http://semver.org) standard, that is:

1. `x.0.0` MAJOR version when you make incompatible API changes (note: DocPad plugins must use v2 as the major version, as v2 corresponds to the current DocPad v6.x releases)
1. `x.y.0` MINOR version when you add functionality in a backwards-compatible manner
1. `x.y.z` PATCH version when you make backwards-compatible bug fixes

1. Add an entry to the changelog following the format of the previous entries, an example of this is:

``` markdown
```markdown
## v6.29.0 2013 April 1
- Progress on [issue #474](https://github.com/bevry/docpad/issues/474)
- DocPad will now set permissions based on the process's ability
- Thanks to [Avi Deitcher](https://github.com/deitch), [Stephan Lough](https://github.com/stephanlough) for [issue #165](https://github.com/bevry/docpad/issues/165)
- Updated dependencies
```
- Progress on [issue #474](https://github.com/docpad/docpad/issues/474)
- DocPad will now set permissions based on the process's ability
- Thanks to [Avi Deitcher](https://github.com/deitch), [Stephan Lough](https://github.com/stephanlough) for [issue #165](https://github.com/docpad/docpad/issues/165)
- Updated dependencies
```
1. Commit the changes with the commit title set to something like `v6.29.0. Bugfix. Improvement.` and commit description set to the changelog entry
1. Ensure the project is ready for publishing:
```
Expand All @@ -119,6 +113,6 @@ To publish your changes as the project owner:
1. Prepare the release and publish it to npm and git:
``` bash
```bash
npm run our:release
```
18 changes: 13 additions & 5 deletions HISTORY.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
# History

## v2.3.0 2020 August 6

- Updated dependencies, [base files](https://github.com/bevry/base), and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)
- Minimum required node version changed from `node: >=0.12` to `node: >=10` to keep up with mandatory ecosystem changes

## v2.2.0 2018 July 11
- Updated base files using [boundation](https://github.com/bevry/boundation)
- Compiled with CoffeeScript v2

- Updated base files using [boundation](https://github.com/bevry/boundation)
- Compiled with CoffeeScript v2

## v2.1.0 2017 April 10
- Updated base files
- Minimum supported node version is now 0.12, as earlier versions are no longer supported by the node ecosystem

- Updated base files
- Minimum supported node version is now 0.12, as earlier versions are no longer supported by the node ecosystem

## v2.0.0 2017 February 27
- Based off [docpad-plugin-jade](https://github.com/docpad/docpad-plugin-jade/)

- Based off [docpad-plugin-jade](https://github.com/docpad/docpad-plugin-jade/)
4 changes: 2 additions & 2 deletions LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Unless stated otherwise all works are:

<ul><li>Copyright &copy; 2012+ <a href="http://bevry.me">Bevry Pty Ltd</a></li>
<li>Copyright &copy; 2011 <a href="http://balupton.com">Benjamin Lupton</a></li></ul>
<li>Copyright &copy; 2011 <a href="https://balupton.com">Benjamin Lupton</a></li></ul>

and licensed under:

Expand All @@ -16,7 +16,7 @@ and licensed under:
<pre>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
</pre>
Expand Down
Loading

0 comments on commit 5188173

Please sign in to comment.