From patchwork Thu May 22 13:04:45 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: kim.hansen@prevas.dk X-Patchwork-Id: 351487 X-Patchwork-Delegate: esben@haabendal.dk Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from hugin.dotsrc.org (hugin.dotsrc.org [IPv6:2001:878:346::102]) by ozlabs.org (Postfix) with ESMTP id AC4A0140076 for ; Thu, 22 May 2014 23:09:02 +1000 (EST) Received: from hugin.dotsrc.org (localhost [127.0.0.1]) by hugin.dotsrc.org (Postfix) with ESMTP id DC93C3F9B8 for ; Thu, 22 May 2014 15:08:56 +0200 (CEST) X-Original-To: dev@oe-lite.org Delivered-To: dev@oe-lite.org Received: from mail01.prevas.se (mail01.prevas.se [62.95.78.3]) by hugin.dotsrc.org (Postfix) with ESMTPS id 1697B3F9B8 for ; Thu, 22 May 2014 15:08:55 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=prevas.dk; i=@prevas.dk; l=4085; q=dns/txt; s=ironport1; t=1400764135; x=1432300135; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=nzEJ0kLMOM0PJrRJa1VxkiaD73ejHxf8iti4xI2ShbQ=; b=Uvj73xZJ1Frwpk87ONe3BRlhsOg9AtOZqJSjcZeNd0msWdMkmI/fOliD SV1SVtFCfUyZEexSKtZVUQQrjUkskAmWsojYNXKP9TnITyAebaLh2EMzz kUptQQm3YzNyl6deD72JjtydYI37J9+kGz8DWpVP6kYUVfYJ8aHRmAlKq Q=; X-IronPort-AV: E=Sophos;i="4.98,887,1392159600"; d="scan'208";a="4739943" Received: from vmprevas3.prevas.se (HELO smtp.prevas.se) ([172.16.8.103]) by ironport1.prevas.se with ESMTP/TLS/AES128-SHA; 22 May 2014 15:08:55 +0200 Received: from arh146.prevas.dk (172.16.11.14) by smtp.prevas.se (172.16.8.105) with Microsoft SMTP Server (TLS) id 14.2.347.0; Thu, 22 May 2014 15:08:53 +0200 Received: by arh146.prevas.dk (Postfix, from userid 1000) id 670FF2740264; Thu, 22 May 2014 15:04:50 +0200 (CEST) From: To: Subject: [bakery] Start using Asciidoc for documentation. Add release doc Date: Thu, 22 May 2014 15:04:45 +0200 Message-ID: <1400763885-10292-1-git-send-email-kim.hansen@prevas.dk> X-Mailer: git-send-email 1.8.5.3 MIME-Version: 1.0 X-Originating-IP: [172.16.11.14] X-BeenThere: dev@oe-lite.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: OE-lite development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: dev-bounces@oe-lite.org Errors-To: dev-bounces@oe-lite.org From: Kim Højgaard-Hansen --- doc/Makefile | 13 +++++++++ doc/documentation.txt | 23 ++++++++++++++++ doc/release.txt | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 112 insertions(+) create mode 100644 doc/Makefile create mode 100644 doc/documentation.txt create mode 100644 doc/release.txt diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..84b5f94 --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,13 @@ +.PHONY: all +all: documentation.html documentation.pdf +html: documentation.html + +.PHONY: clean +clean: + rm -f *.html *.pdf *~ + +documentation.html: $(wildcard *.txt) + asciidoc -b html5 documentation.txt + +documentation.pdf: $(wildcard *.txt) + a2x -a docinfo -d book -f pdf --fop documentation.txt diff --git a/doc/documentation.txt b/doc/documentation.txt new file mode 100644 index 0000000..cdf473e --- /dev/null +++ b/doc/documentation.txt @@ -0,0 +1,23 @@ +// -*- Doc -*- + +Documentation for the OE-lite bakery project +============================================ +:author: Esben Haabendal, Kim Højgaard-Hansen +:email: esben.haabendal@prevas.dk, kim.hansen@prevas.dk +:doctype: book +:theme: volnitsky +:toc2: +:icons: +:pygments: +:bake: OE-lite bakery + +[preface] +{bake} documentation +-------------------- + +This document serves as documentation of various aspects of the +tool used to build OE-lite based projects: {bake} + +:leveloffset: 1 + +include::release.txt[] diff --git a/doc/release.txt b/doc/release.txt new file mode 100644 index 0000000..6e1f44c --- /dev/null +++ b/doc/release.txt @@ -0,0 +1,76 @@ +// -*- Doc -*- + +Release process +=============== + +This chapter describes how a new release of {bake} is made. + +.The steps needed to make a new release are: +- Create temporary release commit +- Run ppa_upload.sh +- Tag the new release in git +- Create tarballs for OE-lite.org +- Upload to PyPi + +Create temporary release commit +------------------------------- + +First make an initial commit with version and changelog changes for the release. + +edit `oebakery/oe.py` and `oebakery/__init__.py and add the new version. + +edit `debian/changelog` with info for the new release. Take a look at the previous +release commits to see how to do this. + +Run `ppa_upload.sh` +------------------- + +First look at: https://launchpad.net/ubuntu under "Active series and milestones" +to check what ubuntu releases are still active. The newest non-LTS release can often +be skipped. + +Then edit `ppa_upload.sh`: + +`LEAD_DISTRO="trusty" #preferred distro, most likely newest LTS` +`OLD_DISTROES="lucid precise quantal saucy" #the rest of the active releases` + +run `ppa_upload.sh` + +NOTE: currently requires `~/.dput.cf` and Esbens GPG key. + +WARNING: Wait until the PPAs have been created before proceeding to the next step. + +Tag the new release in Git +-------------------------- + +`git tag -a -m 'release 4.2.0' v4.2.0` + +Create tarballs for OE-lite.org +------------------------------- + +Change directory to the parent directory of the {bake} source: + +`git archive --prefix=bakery-4.2.0/ -o oe-lite-bakery-4.2.0.tar v4.2.0` + +`cat oe-lite-bakery-4.2.0.tar | gzip > oe-lite-bakery-4.2.0.tar.gz && +cat oe-lite-bakery-4.2.0.tar | bzip2 > oe-lite-bakery-4.2.0.tar.bz2 && +cat oe-lite-bakery-4.2.0.tar | xz > oe-lite-bakery-4.2.0.tar.xz` + +Upload the tarballs to http://oe-lite.org/download/bakery/ + +For more information see: http://oe-lite.org/doc/handbook/handbook.html#_release_management + +Upload to PyPi +-------------- + +WARNING: FIXME + +TODO +---- + +Wishes for improved releases process include: + +- Figure out if the https://build.opensuse.org/[OpenSuse Open Build Service (OBS)] +could be used to release binaries for more distroes +- Create team/group/project PPA instead of Esbens personal for releases +- Can `debchange` be used to make the changelog edits?