We need a release process about circe

[twopir]

Emacs24 ships with ELPA, a package mangler. We should probably be compatible with that.

[jorgenschaefer]

Yes. I don't use package.el, does anyone know how that stuff works? :o)

[jorgenschaefer]

Apparently: Have a file called circe-pkg.el in your root containing this:

(define-package "circe" "0.5" "A Client for IRC in Emacs")
;; no-byte-compile: t

And make a circe-0.5.tar out of it (note .tar, not .tar.gz – wtf?).

How would we get it into the official GNU elpa?

[jorgenschaefer]

• Add release argument to build.sh:
  • Tags the current commit with git tag vX.Y.Z
  • Creates a circe-/ directory
  • Generates circe-auto.el and circe-pkg.el
  • Byte-compiles files in the lisp/ directory in there
  • Make a tar.gz out of that directory, and delete the directory
• Push the tag with git push --tags
• Upload the .tar.gz via https://github.com/jorgenschaefer/circe/downloads
• Do the magic stuff that's needed to get the tar into GNU elpa

Anything I missed?

[jorgenschaefer]

• package.el will try and figure out if a package has a README file. If it does, it will put the contents of that file into the pkg-info vector. It will not do anything with that anymore.
• It supports a circe-readme.txt in package-user-dir. That can be downloaded separately, not in the .tar
• => Copy README.md as circe-readme.txt to elpa, too.
• package.el wants circe-autoloads.el, not circe-auto.el.
• package.el would support info documentation. I don't see a particular need to revive that, though (non-wiki documentation tends to be very, very outdated)

[jorgenschaefer]

Apparently, that README is used anyhow. Just didn't find where. Fancy.

http://marmalade-repo.org/doc-files/package.5.html has the marmalade documentation.

marmalade is self-signup, I'll do that for releases until we figure out how GNU works.

[jorgenschaefer]

So, process now:

• Add release argument to build.sh:
  • Tags the current commit with git tag vX.Y.Z
  • Creates a circe-/ directory
  • Rename README.md to README
  • Generates circe-autoloads.el (new name!) and circe-pkg.el
  • Byte-compiles files in the lisp/ directory
  • Make a .tar and a .tar.gz out of that directory, and delete the directory
• Push the tag with git push --tags
• Upload the .tar.gz via https://github.com/jorgenschaefer/circe/downloads
• Upload the .tar via http://marmalade-repo.org/

Anything I missed? :-)

[jorgenschaefer]

Actually, we probably want a separate README with the package description as opposed to copying the README.md, as that includes installation instructions irrelevant to package.el. Possibly just automatically extract the "Overview" and and "Documentation" sections.

Also, package.el apparently expects all files in the main directory of the .tar, so we should likely do exactly that.

[jorgenschaefer]

build.sh should create separate elpa packages for Circe, lui, tracking, and lcs to allow individual dependency by scripts.