From: W. Trevor King Date: Fri, 20 Nov 2009 21:48:07 +0000 (-0500) Subject: Fixed bug 529c290e-b1cf-4800-be7e-68f1ecb9565c (howto version BE). X-Git-Tag: 1.0.0~59^2~78 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=64cb5e5ec672cd357bc66a8480465e531db25f52;p=be.git Fixed bug 529c290e-b1cf-4800-be7e-68f1ecb9565c (howto version BE). Also appended some of the recent discussion about releases to the comment list. --- diff --git a/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/1847f1f8-525a-42c4-ae2b-e9377459d2a6/body b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/1847f1f8-525a-42c4-ae2b-e9377459d2a6/body new file mode 100644 index 0000000..8c890f3 --- /dev/null +++ b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/1847f1f8-525a-42c4-ae2b-e9377459d2a6/body @@ -0,0 +1,27 @@ +"W. Trevor King" writes: + +> On Tue, Nov 17, 2009 at 01:41:26PM -0300, Nicolas Alvarez wrote: +> > I'm using the latest version available on Debian +> > (0.0.193+bzr.r217-2). I should ask for an updated package... +> +[…] + +> There is also an outstanding Debian bug for updating the Debian package +> http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=544515 +> so there may be a more current package on the way, but I don't know +> about timeframes for that sort of thing. + +It would make it much easier on the Debian package maintainer if the +Bugs Everywhere project would make conventional tarball releases, with +conventional version numbers, with a changelog describing what has +changed between versions. + +Trying to maintain a package of a project that is only made available by +undifferentiated VCS revision numbers is a lot more effort, and so +doesn't happen very often. + +-- + \ “Roll dice!” “Why?” “Shut up! I don't need your fucking | + `\ *input*, I need you to roll dice!” —Luke Crane, demonstrating | +_o__) his refined approach to play testing, 2009 | +Ben Finney diff --git a/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/1847f1f8-525a-42c4-ae2b-e9377459d2a6/values b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/1847f1f8-525a-42c4-ae2b-e9377459d2a6/values new file mode 100644 index 0000000..dbd9a0c --- /dev/null +++ b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/1847f1f8-525a-42c4-ae2b-e9377459d2a6/values @@ -0,0 +1,8 @@ +Alt-id: <87d43gn8ju.fsf_-_@benfinney.id.au> + + +Content-type: text/plain + + +Date: Wed, 18 Nov 2009 13:30:29 +0000 + diff --git a/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/49e0425b-3332-4d0e-b371-300eccd55370/body b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/49e0425b-3332-4d0e-b371-300eccd55370/body new file mode 100644 index 0000000..4ebb4f2 --- /dev/null +++ b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/49e0425b-3332-4d0e-b371-300eccd55370/body @@ -0,0 +1,51 @@ +"W. Trevor King" writes: + +> ** NEWS file + +Speaking as the package maintainer, I would like a ‘ChangeLog’ file +separate from a ‘NEWS’ file. + +The ‘NEWS’ file would continue to be hand-edited, and would be a +high-level view of user-visible changes in the project each version. +Users could reasonably expect to be interested in this file when +installing a new version. It would also make sense to retire old news +From this file once it becomes sufficiently old, to keep it relevant to +users to read. + + +The ‘ChangeLog’ would be an automatically-generated changelog of +low-level changes, not for general human consumption but for letting +recipients have a fighting chance at knowing the historical context of a +particular change without access to the VCS. It would probably be best +done as Trevor says: + +> Depending on our level of masochism, either something starting out +> along the lines of [2] +> bzr log --gnu-changelog -n1 -r 200.. + +That makes it necessary to add the changelog file to the tarball, since +it won't be a file tracked by VCS and therefore won't be exported. Not a +problem:: + + $ release_version="1.0.0" + $ release_name="be-$release_version" + $ tarball_file=../$release_name.tar.gz + $ work_dir=$(mktemp -t -d) + $ export_dir=$work_dir/$release_name + $ changelog_file=$export_dir/ChangeLog + + $ bzr export $export_dir + $ bzr log --gnu-changelog -n1 -r ..tag:"$release_version" > $changelog_file + $ tar -czf $tarball_file $export_dir + $ rm -r $work_dir/ + + $ ls $tarball_file + ../be-1.0.0.tar.gz + $ tar -tzf $tarball_file | grep ChangeLog + be-1.0.0/ChangeLog + +-- + \ “I bought a dog the other day. I named him Stay. It's fun to | + `\ call him. ‘Come here, Stay! Come here, Stay!’ He went insane. | +_o__) Now he just ignores me and keeps typing.” —Steven Wright | +Ben Finney diff --git a/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/49e0425b-3332-4d0e-b371-300eccd55370/values b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/49e0425b-3332-4d0e-b371-300eccd55370/values new file mode 100644 index 0000000..770f0b4 --- /dev/null +++ b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/49e0425b-3332-4d0e-b371-300eccd55370/values @@ -0,0 +1,11 @@ +Alt-id: <873a4cmjw5.fsf@benfinney.id.au> + + +Content-type: text/plain + + +Date: Wed, 18 Nov 2009 22:23:06 +0000 + + +In-reply-to: a4720227-43cf-49aa-8f9f-f49f46e3e809 + diff --git a/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/72a519e3-3d6b-4f0f-b412-1310efd255eb/body b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/72a519e3-3d6b-4f0f-b412-1310efd255eb/body new file mode 100644 index 0000000..d00eb64 --- /dev/null +++ b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/72a519e3-3d6b-4f0f-b412-1310efd255eb/body @@ -0,0 +1,22 @@ +Hi, + + > It would make it much easier on the Debian package maintainer if + > the Bugs Everywhere project would make conventional tarball + > releases, with conventional version numbers, with a changelog + > describing what has changed between versions. + +Fair point. + +How do people feel about pushing for a 1.0 release, with Trevor's tree +plus a finished cfbe merge? Or would we rather wait until afterwards +to try for cfbe? + +- Chris. +-- +Chris Ball +One Laptop Per Child + +_______________________________________________ +Be-devel mailing list +Be-devel@bugseverywhere.org +http://void.printf.net/cgi-bin/mailman/listinfo/be-devel diff --git a/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/72a519e3-3d6b-4f0f-b412-1310efd255eb/values b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/72a519e3-3d6b-4f0f-b412-1310efd255eb/values new file mode 100644 index 0000000..4fb068d --- /dev/null +++ b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/72a519e3-3d6b-4f0f-b412-1310efd255eb/values @@ -0,0 +1,14 @@ +Alt-id: + + +Author: Chris Ball + + +Content-type: text/plain + + +Date: Tue, 17 Nov 2009 22:53:31 +0000 + + +In-reply-to: 1847f1f8-525a-42c4-ae2b-e9377459d2a6 + diff --git a/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/96abea83-9867-4c21-8eb8-9e1b1093cba4/body b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/96abea83-9867-4c21-8eb8-9e1b1093cba4/body new file mode 100644 index 0000000..a3fc57f --- /dev/null +++ b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/96abea83-9867-4c21-8eb8-9e1b1093cba4/body @@ -0,0 +1,36 @@ +I've written up a little release script that bundles all the steps +we've mentioned so far into a single command. Of course, we'll still +have to keep NEWS up to date on our own. + +The output prints a trace of what's going on: + + $ ./release.py 1.0.0 + set libbe.version._VERSION = '1.0.0' + updating AUTHORS + updating ./becommands/assign.py + updating ./becommands/html.py + ... + commit current status: Bumped to version 1.0.0 + tag current revision 1.0.0 + export current revision to be-1.0.0 + generate libbe/_version.py + copy libbe/_version.py to be-1.0.0/libbe/_version.py + generate ChangeLog file be-1.0.0/ChangeLog up to tag 1.0.0 + set vcs_name in be-1.0.0/.be/settings to None + create tarball be-1.0.0.tar.gz + remove be-1.0.0 + +Since we'll be distributing a non-bzr-repo version, it would be nice +to adapt our 'submit bug' procedure (outlined on the main page) to one +that works with this setup. Without guaranteed versioning, that would +probably be something along the lines of + be email-bugs [--to be-devel@bugseverywhere.org] BUG-ID ... +With interfaces/email/interactive listening on the recieving end to +grab new-bug emails and import them into an incoming bug repository. + +-- +This email may be signed or encrypted with GPG (http://www.gnupg.org). +The GPG signature (if present) will be attached as 'signature.asc'. +For more information, see http://en.wikipedia.org/wiki/Pretty_Good_Privacy + +My public key is at http://www.physics.drexel.edu/~wking/pubkey.txt diff --git a/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/96abea83-9867-4c21-8eb8-9e1b1093cba4/values b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/96abea83-9867-4c21-8eb8-9e1b1093cba4/values new file mode 100644 index 0000000..83fcd63 --- /dev/null +++ b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/96abea83-9867-4c21-8eb8-9e1b1093cba4/values @@ -0,0 +1,11 @@ +Alt-id: <20091120132219.GA17577@mjolnir.home.net> + + +Content-type: text/plain + + +Date: Fri, 20 Nov 2009 13:22:19 +0000 + + +In-reply-to: 49e0425b-3332-4d0e-b371-300eccd55370 + diff --git a/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/a4720227-43cf-49aa-8f9f-f49f46e3e809/body b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/a4720227-43cf-49aa-8f9f-f49f46e3e809/body new file mode 100644 index 0000000..5d29f85 --- /dev/null +++ b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/a4720227-43cf-49aa-8f9f-f49f46e3e809/body @@ -0,0 +1,102 @@ +On Tue, Nov 17, 2009 at 05:53:31PM -0500, Chris Ball wrote: +> > It would make it much easier on the Debian package maintainer if +> > the Bugs Everywhere project would make conventional tarball +> > releases, with conventional version numbers, with a changelog +> > describing what has changed between versions. +> How do people feel about pushing for a 1.0 release, with Trevor's tree +> plus a finished cfbe merge? Or would we rather wait until afterwards +> to try for cfbe? + +Sounds good to me. Not that my tree is much ahead of the trunk at the +moment. We've talked over most of these issues a few times, so I'll +just summarize where I think we stand on the steps needed to make a +release. + +** cfbe integration + +Postpone until we work out bzr/hg versioning [1]? + +** Conventional version number + +Set to "1.0.0" using libbe.version._VERSION. + +** NEWS file + +Depending on our level of masochism, either something starting out +along the lines of [2] + bzr log --gnu-changelog -n1 -r 200.. +(commit 200, or + aaron.bentley@utoronto.ca-20060411035623-9b8d222282a26ce1 + was the last time anyone touched the NEWS file), +or a much abbreviated entry [3,4], along the lines of my current NEWS +file (changed just a few minutes ago). + +** Tag bzr commit + + bzr tag 1.0.0 + +** Create tarball + +From Ben[5]: + bzr export /tmp/be-1.0.0.tar.gz + + +References: + +[1] +On Thu, Jul 23, 2009 at 05:38:03PM -0400, Steve Losh wrote: +> On Jul 21, 2009, at 9:59 AM, W. Trevor King wrote: +> > Steve's also versioning it with Mercurial. Will he mind changing to +> > Bazaar? +> +> Yeah, I've tried bazaar but really don't like the interface at all. If +> everyone else really wants me to move it over I guess I can though. + +[2] +On Tue, Jul 14, 2009 at 11:05:38AM -0400, Chris Ball wrote: +> Actually, there's a `bzr log --gnu-changelog` now, and `bzr help +> log-formats` offers some more styles. (None of them seem to match +> my preferred style for release announcements exactly, which would +> be `git shortlog`-style.) + +[3] +On Thu, Jul 16, 2009 at 07:21:10PM +1000, Ben Finney wrote: +> I actually don't think the commit log needs to be part of the release at +> all. It's of interest only to those who want fine-level detail about +> changes to every file, and for that purpose I think read access to the +> VCS is much better. Packaging a static copy of the commit log as plain +> text seems pointless. +> +> Rather, we should treat a user-changes level “NEWS” file (or whatever +> name we choose for it) as part of the documentation, and set the +> expectation among the team that it will be updated for each user-visible +> change being worked on, like any other documentation. + +[4] +On Tue, Jul 14, 2009 at 11:11:31AM -0400, Chris Ball wrote: +> Hi, +> +> > That's not a changelog, that's a commit log of every source-level +> > commit made. Far too much detail for a changelog of +> > *user-visible* changes associated with a release. +> +> I think I agree with both of you. :) It seems like it's both true that +> there's no point in keeping a GNU-style ChangeLog these days, and that +> if we make a release we should write an announce mail that directly +> mentions new user-visible changes as well as attaching the commit log. +> That smaller list of highly user-visible changes could live in NEWS, +> or in the announce mail, or both. + +[5] +On Wed, Jul 15, 2009 at 12:54:05AM +1000, Ben Finney wrote: +> Even better: ‘bzr export /tmp/foo.tar.gz’ will create a source tarball +> of all the files in the branch's VCS inventory. All we need to do is +> start the practice of tagging a release in the VCS, and export the +> tarball at that time. + +-- +This email may be signed or encrypted with GPG (http://www.gnupg.org). +The GPG signature (if present) will be attached as 'signature.asc'. +For more information, see http://en.wikipedia.org/wiki/Pretty_Good_Privacy + +My public key is at http://www.physics.drexel.edu/~wking/pubkey.txt diff --git a/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/a4720227-43cf-49aa-8f9f-f49f46e3e809/values b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/a4720227-43cf-49aa-8f9f-f49f46e3e809/values new file mode 100644 index 0000000..99b8978 --- /dev/null +++ b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/a4720227-43cf-49aa-8f9f-f49f46e3e809/values @@ -0,0 +1,11 @@ +Alt-id: <20091118011403.GB9503@mjolnir.home.net> + + +Content-type: text/plain + + +Date: Wed, 18 Nov 2009 01:14:03 +0000 + + +In-reply-to: 72a519e3-3d6b-4f0f-b412-1310efd255eb + diff --git a/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/f92c6180-0ed8-4acc-8ced-22995a0c016b/body b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/f92c6180-0ed8-4acc-8ced-22995a0c016b/body new file mode 100644 index 0000000..dee72c7 --- /dev/null +++ b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/f92c6180-0ed8-4acc-8ced-22995a0c016b/body @@ -0,0 +1,2 @@ +Verdict: run releases.py periodically, and post the tarballs on the +web. diff --git a/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/f92c6180-0ed8-4acc-8ced-22995a0c016b/values b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/f92c6180-0ed8-4acc-8ced-22995a0c016b/values new file mode 100644 index 0000000..2e85e56 --- /dev/null +++ b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/comments/f92c6180-0ed8-4acc-8ced-22995a0c016b/values @@ -0,0 +1,8 @@ +Author: W. Trevor King + + +Content-type: text/plain + + +Date: Fri, 20 Nov 2009 21:45:50 +0000 + diff --git a/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/values b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/values index b9e8dff..89203d2 100644 --- a/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/values +++ b/.be/bugs/529c290e-b1cf-4800-be7e-68f1ecb9565c/values @@ -7,7 +7,7 @@ reporter: W. Trevor King severity: wishlist -status: open +status: fixed summary: How should we version BE?