-
-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Release procedure
JohnMcLear edited this page Jan 30, 2013
·
17 revisions
- Consider, which changes (aka commits) you want to release into master (This commit comparison view is quite useful)
- Determine the new version number, following semantic versioning spec.
- Move the relevant commits into a new branch
release/x.x.x
[using this git flow technique] (http://mclear.co.uk/2012/10/03/using-git-flow-to-release-new-version/) - Ensure, all version numbers are up-to-date
- Be sure the API version is correct (new endpoints shouldn't be added to already existing API versions)
- Update the version number in
package.json
(and elsewhere?) - Create a new entry in the changelog, documenting all changes.
- Push
release/x.x.x
to github - Open a pull request from
release/x.x.x
tomaster
- Once the pull request is merged into master, tag the the merge commit with
x.x.x
- Create a new windows build
- Run
bin/buildForWindows.sh
- Name the resulting zip file:
etherpad-lite-win-x.x.x-<git-sha>.zip
- Ask John McLear to upload the file to beta.etherpad.org (https://github.com/ether/etherpad-lite/downloads) *Temporary until we can find a better solution
- Update the docs
- Build the docs with
make docs
- Put the contents of
out/doc/
into a new directorydoc/vX.X.X/
inside ether.github.com - Adjust all links on ether.github.com
- Update the version numbers on all download buttons
- Update the documentation link (version number in url and text) on the website
- Push ether.github.com to github
- Put up some notices on relevant sites, announcing the new release as well as possibly critical changes it introduces.
- Pull master branch over develop
- Update the beta.etherpad.org instance using git pull
Note that steps 9.3 and 14 are for Etherpad Site Admins
- Docs
- Translating
- HTTP API
- Plugin framework (API hooks)
- Plugins (available)
- Plugins (list)
- Plugins (wishlist)
- Etherpad URIs / URLs to specific resources IE export
- Etherpad Full data export
- Introduction to the source
- Release Procedure
- Etherpad Developer guidelines
- Project to-do list
- Changeset Library documentation
- Alternative Etherpad-Clients
- Contribution guidelines
- Installing Etherpad
- Deploying Etherpad as a service
- Deploying Etherpad on CloudFoundry
- Deploying Etherpad on Heroku
- Running Etherpad on Phusion Passenger
- Putting Etherpad behind a reverse Proxy (HTTPS/SSL)
- How to setup Etherpad on Ubuntu 12.04 using Ansible
- Migrating from old Etherpad to Etherpad
- Using Etherpad with MySQL
- Customizing the Etherpad web interface
- Enable import/export functionality with AbiWord
- Getting a list of all pads
- Providing encrypted web access to Etherpad using SSL certificates
- Optimizing Etherpad performance including faster page loads
- Getting to know the tools and scripts in the Etherpad /bin/ folder
- Embedding a pad using the jQuery plugin
- Using Embed Parameters
- Integrating Etherpad in a third party app (Drupal, MediaWiki, WordPress, Atlassian, PmWiki)
- HTTP API client libraries