Skip to content

DEPLOYMENT.md

Latest commit

 

History

History
74 lines (58 loc) · 11.4 KB

DEPLOYMENT.md

File metadata and controls

74 lines (58 loc) · 11.4 KB

Deployment of workshoppers

This document should help you when deploying new workshopper tutorials to npm and on github.

Note: We have control over the following npm organizations: workshopper and nodeschool. If you need access to either please create an issue in this repository, mentioning your intent and npm username.

Current versions and build status

workshopper NPM Github CI
adventure npm GitHub tag Build Status
browserify-adventure npm GitHub tag Build Status
goingnative npm GitHub tag Build Status
how-to-markdown npm GitHub tag Build Status
how-to-npm npm GitHub tag Build Status
i18n-it-all npm GitHub tag Build Status
javascripting npm GitHub tag Build Status
learn-sass npm GitHub tag Build Status
learnyounode npm GitHub tag Build Status
learnyoureact npm GitHub tag Build Status
levelmeup npm GitHub tag Build Status
regex-adventure npm GitHub tag Build Status
scope-chains-closures npm GitHub tag Build Status
stream-adventure npm GitHub tag Build Status
workshopper npm GitHub tag Build Status
workshopper-adventure npm GitHub tag Build Status
workshopper-adventure-storage npm GitHub tag Build Status
workshopper-adventure-test npm GitHub tag Build Status
workshopper-boilerplate npm GitHub tag Build Status
workshopper-exercise npm GitHub tag Build Status
workshopper-more npm GitHub tag Build Status
workshopper-wrappedexec npm GitHub tag Build Status

Requirements

Please prepare the following prerequisites for package deployment:

  • New version of the package should follow semantic versioning.
  • Ensure that the project github repository of the workshopper is correctly setup and working with Travis CI.
  • Master branch of the github repository has at least basic coverage for tests and code quality.
  • Provide comprehensive changelog for the release.

Please note that deployments to npm are made regularly and on request. Hotfixes with urgency are discouraged (i.e. please respect the time of volunteers working on the deployments)

Submiting a deployment request

Steps to follow:

  • Please read and prepare the prerequisites mentioned in the "Requirements" section.
  • Create a request ticket on the board for deployment requests.
  • Be patient and provide support where and when necessary.

Guidelines

This list is aimed to help you progress in preparing your package for deployment.

Travis CI

  • Free service for open source projects.
  • Runs tests and code quality checks automatically.
  • The master branch of your repository should be passing the checks.

Here's an example shield you can take for your particular repository.

[![Build Status](https://travis-ci.org/workshopper/javascripting.svg?branch=master)](https://travis-ci.org/workshopper/javascripting)

Further reading on Travis CI with node.js.

Changelogs

  • Should be named as CHANGELOG or CHANGELOG.md
  • Should reside in the root of the master of the github repository
  • Should contain brief information about the changes done between releases
  • Could use an automated tool such as standard-version

Here's an example of automatically generated changelog which can be generated following commit message conventions.