Skip to content

Commit

Permalink
docs: move wiki&publish to MAINTAINING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
develar committed May 23, 2016
1 parent e4eefb2 commit b2ab07f
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 17 deletions.
18 changes: 1 addition & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,24 +76,8 @@ The footer should contain any information about **Breaking Changes** and is also

A detailed explanation can be found in this [document](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#).

# Publishing to NPM
We use [semantic-release](https://github.com/semantic-release/semantic-release) to fully automate package publishing.
Every successful continuous integration build of the master branch is analyzed and
new version will be published if `fix`, `feat` or `BREAKING CHANGE` [detected](https://github.com/semantic-release/semantic-release#patch-release).

# Documentation

Don't edit wiki directly. Instead, edit files in the `/docs`.

`/docs` is synced to wiki using git subtree merge when `next` release is marked as `latest` and available for all users.

## Sync wiki
Only if you have write access. Create pull request otherwise.

To add `wiki` upstream:
```
git remote add upstream https://github.com/electron-userland/electron-builder.wiki.git
```

To sync docs: `npm run update-wiki`

`/docs` is synced to wiki using git subtree merge when `next` release is marked as `latest` and available for all users.
12 changes: 12 additions & 0 deletions MAINTAINING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Publishing to NPM
We use [semantic-release](https://github.com/semantic-release/semantic-release) to fully automate package publishing.
Every successful continuous integration build of the master branch is analyzed and
new version with tag `next` will be published if `fix`, `feat` or `BREAKING CHANGE` [detected](https://github.com/semantic-release/semantic-release#patch-release).

# Sync wiki
To add `wiki` upstream:
```
git remote add upstream https://github.com/electron-userland/electron-builder.wiki.git
```

To sync: `npm run update-wiki`

0 comments on commit b2ab07f

Please sign in to comment.