Skip to content

Commit

Permalink
tests passing, balupton-website working
Browse files Browse the repository at this point in the history
Done in this commit:

- fixed configuration merging, details at
#1045 (comment)
- updated watchr to v3
  - changed signatures of `watchdir` and added `watchdirs`
- updated scandirectory to v3
  - implemented in `parseDirectory` and `loadPlugins`
- core tests now passing
- watch working on @balupton's website:
https://github.com/balupton/website
- added beta tag to release process
- updated editions standard
- rebuilt meta files
- updated base files
- removed safe mode option docs, will never end up getting added

Still todo:

- tests plugins against this version

Ref #1045
  • Loading branch information
balupton committed Oct 20, 2016
1 parent b6a0d49 commit cadd4a5
Show file tree
Hide file tree
Showing 37 changed files with 1,509 additions and 1,315 deletions.
7 changes: 6 additions & 1 deletion .gitignore
@@ -1,7 +1,8 @@
# 27 March 2015
# 2016 October 17
# https://github.com/bevry/base

# Temp Files
yarn.lock
**/.docpad.db
**/out.*
**/*.log
Expand All @@ -14,8 +15,12 @@ components/
bower_components/
node_modules/
out/
*output/
coffeejs/
coffee/
es5/
es2015/
esnext/

# Editor Caches
.c9/
Expand Down
24 changes: 16 additions & 8 deletions .npmignore
@@ -1,7 +1,8 @@
# 27 March 2015
# 2016 October 17
# https://github.com/bevry/base

# Temp Files
yarn.lock
**/.docpad.db
**/out.*
**/*.log
Expand All @@ -17,19 +18,26 @@ node_modules/
# Private Files
.env

# Documentation Files
docs/
guides/
BACKERS.md
CONTRIBUTING.md
HISTORY.md

# Development Files
web/
**/example*
**/test*
.editorconfig
.eslintrc
.eslintrc*
.jshintrc
coffeelint.json
.jscrc
coffeelint*
.travis*
nakefile*
Cakefile
Makefile
BACKERS.md
CONTRIBUTING.md
HISTORY.md
**/src/
**/test/

# Other Package Definitions
template.js
Expand Down
139 changes: 135 additions & 4 deletions CONTRIBUTING.md
@@ -1,5 +1,136 @@
# Contributing
<!--
2016 October 4
https://github.com/bevry/base
-->

- [Contributing Guide](https://docpad.org/docs/contribute)
- [Support Channels](https://discuss.bevry.me/t/official-bevry-support-channels/63)
- We no longer use GitHub Issues as a support channel. Refer to the above instead.
# Before You Post!

## Support

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://learn.bevry.me/community/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. Fork the project and clone your fork - [guide](https://help.github.com/articles/fork-a-repo/)

1. Install local dependencies

``` bash
npm install
```

1. Perform any other setup operations

``` bash
npm run-script setup
```


### Developing

1. Compile changes

``` bash
npm run-script compile
```

1. Run tests

``` 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
npm test
```

> If possible, add tests for your change, if you don't know how, mention this in your pull request
1. Ensure the project is ready for publishing:

```
git status
git diff
npm run-script prepare
```


#### Pull Request

To send your changes for the project owner to merge in:

1. Submit your pull request
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
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
## 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
```


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:

```
git status
git diff
npm run-script prepare
```

1. Prepare the release and publish it to npm and git:

``` bash
npm run-script release
```

> A prompt will occur asking you for a git tag annotation, enter the changelog entry that we created earlier, save and exit the prompt.
6 changes: 6 additions & 0 deletions HISTORY.md
@@ -1,5 +1,11 @@
# History

## v6.79.0 2016 October 20
- This is a beta release, use `npm install --save docpad@beta` to grab it
- Configuration loading is merged more accurately
- Updated majors of many dependencies
- Closes [issue #1045](https://github.com/docpad/docpad/issues/1045)

## v6.78.5 2016 June 15
- Recompiled with latest dev dependencies

Expand Down
9 changes: 6 additions & 3 deletions README.md
Expand Up @@ -195,10 +195,10 @@ These amazing people have contributed code to this project:
<li><a href="https://github.com/stegrams">Stefanos Grammenos</a> — <a href="https://github.com/docpad/docpad/commits?author=stegrams" title="View the GitHub contributions of Stefanos Grammenos on repository docpad/docpad">view contributions</a></li>
<li><a href="https://github.com/disenchant">Sven Vetsch</a> — <a href="https://github.com/docpad/docpad/commits?author=disenchant" title="View the GitHub contributions of Sven Vetsch on repository docpad/docpad">view contributions</a></li>
<li><a href="http://timaschew.github.io">Anton Wilhelm</a></li>
<li><a href="kendoui.com">Todd Anglin</a> — <a href="https://github.com/docpad/docpad/commits?author=toddanglin" title="View the GitHub contributions of Todd Anglin on repository docpad/docpad">view contributions</a></li>
<li><a href="kendoui.com">Todd Anglin</a></li>
<li><a href="http://www.triplet.fi">Tatu Tamminen</a> — <a href="https://github.com/docpad/docpad/commits?author=ttamminen" title="View the GitHub contributions of Tatu Tamminen on repository docpad/docpad">view contributions</a></li>
<li><a href="http://unframework.com">Nick Matantsev</a> — <a href="https://github.com/docpad/docpad/commits?author=unframework" title="View the GitHub contributions of Nick Matantsev on repository docpad/docpad">view contributions</a></li>
<li><a href="https://github.com/darrrk">Vladislav Botvin</a> — <a href="https://github.com/docpad/docpad/commits?author=darrrk" title="View the GitHub contributions of Vladislav Botvin on repository docpad/docpad">view contributions</a></li>
<li><a href="https://github.com/darky">Vladislav Botvin</a> — <a href="https://github.com/docpad/docpad/commits?author=darky" title="View the GitHub contributions of Vladislav Botvin on repository docpad/docpad">view contributions</a></li>
<li><a href="https://github.com/vsopvsop">vsopvsop</a> — <a href="https://github.com/docpad/docpad/commits?author=vsopvsop" title="View the GitHub contributions of vsopvsop on repository docpad/docpad">view contributions</a></li>
<li><a href="https://github.com/Zearin">Zearin</a> — <a href="https://github.com/docpad/docpad/commits?author=Zearin" title="View the GitHub contributions of Zearin on repository docpad/docpad">view contributions</a></li>
<li><a href="http://firede.us">Firede</a> — <a href="https://github.com/docpad/docpad/commits?author=firede" title="View the GitHub contributions of Firede on repository docpad/docpad">view contributions</a></li>
Expand All @@ -208,7 +208,10 @@ These amazing people have contributed code to this project:
<li><a href="http://blog.shawnzhu.com">Ke Zhu</a> — <a href="https://github.com/docpad/docpad/commits?author=shawnzhu" title="View the GitHub contributions of Ke Zhu on repository docpad/docpad">view contributions</a></li>
<li><a href="https://github.com/chaos95">Morgan Larosa</a> — <a href="https://github.com/docpad/docpad/commits?author=chaos95" title="View the GitHub contributions of Morgan Larosa on repository docpad/docpad">view contributions</a></li>
<li><a href="https://github.com/paularmstrong">Paul Armstrong</a> — <a href="https://github.com/docpad/docpad/commits?author=paularmstrong" title="View the GitHub contributions of Paul Armstrong on repository docpad/docpad">view contributions</a></li>
<li><a href="http://www.prayagverma.com/">Prayag Verma</a> — <a href="https://github.com/docpad/docpad/commits?author=pra85" title="View the GitHub contributions of Prayag Verma on repository docpad/docpad">view contributions</a></li></ul>
<li><a href="http://www.prayagverma.com/">Prayag Verma</a></li>
<li><a href="http://www.stevemcarthur.co.uk">Steve Mc</a> — <a href="https://github.com/docpad/docpad/commits?author=SteveMcArthur" title="View the GitHub contributions of Steve Mc on repository docpad/docpad">view contributions</a></li>
<li><a href="nativescript.org">Todd Anglin</a> — <a href="https://github.com/docpad/docpad/commits?author=toddanglin" title="View the GitHub contributions of Todd Anglin on repository docpad/docpad">view contributions</a></li>
<li><a href="http://www.StylifyYourBlog.com/">Prayag Verma</a> — <a href="https://github.com/docpad/docpad/commits?author=pra85" title="View the GitHub contributions of Prayag Verma on repository docpad/docpad">view contributions</a></li></ul>

<a href="https://github.com/docpad/docpad/blob/master/CONTRIBUTING.md#files">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>

Expand Down
Empty file modified docs/assets/css/external-small.png 100644 → 100755
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/assets/css/logo.png 100644 → 100755
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/assets/css/main.css 100644 → 100755
Empty file.
Empty file modified docs/assets/favicon.ico 100644 → 100755
Empty file.
Empty file modified docs/assets/img/spinner.gif 100644 → 100755
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/assets/index.html 100644 → 100755
Empty file.
Empty file modified docs/assets/js/api-filter.js 100644 → 100755
Empty file.
Empty file modified docs/assets/js/api-list.js 100644 → 100755
Empty file.
Empty file modified docs/assets/js/api-search.js 100644 → 100755
Empty file.
Empty file modified docs/assets/js/apidocs.js 100644 → 100755
Empty file.
Empty file modified docs/assets/js/yui-prettify.js 100644 → 100755
Empty file.
Empty file modified docs/assets/vendor/prettify/CHANGES.html 100644 → 100755
Empty file.
Empty file modified docs/assets/vendor/prettify/COPYING 100644 → 100755
Empty file.
Empty file modified docs/assets/vendor/prettify/README.html 100644 → 100755
Empty file.
Empty file modified docs/assets/vendor/prettify/prettify-min.css 100644 → 100755
Empty file.
Empty file modified docs/assets/vendor/prettify/prettify-min.js 100644 → 100755
Empty file.

0 comments on commit cadd4a5

Please sign in to comment.