MozillaZine

Bash build script

From MozillaZine Knowledge Base

(Difference between revisions)
Revision as of 23:31, 28 November 2004
Asqueella (Talk | contribs)
(wasn't working on MacOSX, see http://forums.mozillazine.org/viewtopic.php?t=172953)
<-- Previous diff
Current revision
Asqueella (Talk | contribs)
(Script 1 - fix from ryan@ryanium.com to support the content registration with flags ("content APPNAME content/ contentaccessible=yes"))
Line 1: Line 1:
-Here is a bash script I'm using to package my extensions (under Linux and Cygwin). For Windows script see [[Dev : Extensions : Windows cmd build script]].+{{extdev}}
-<pre>#!/bin/bash+Two bash scripts that automate [[packaging extensions]].
-# build.sh: build JAR and XPI files from source+
-# based on Nathan Yergler's build script+
-#### editable items (none of these can be blank)+__TOC__
-APP_NAME=menuedit # short-name, jar and xpi files name.+== Script 1 ==
-HAS_DEFAULTS=1 # whether the ext. provides default values for user prefs etc.+Here is a bash script I'm using to package my extensions (under [http://www.cygwin.com/ Cygwin]). See also [[Windows build script]].
-HAS_COMPONENTS=0 # whether the ext. includes any components+
-HAS_LOCALE=1 # package APP_NAME.jar/locale/ ?+
-HAS_SKIN=0 # package APP_NAME.jar/skin/ ?+
-KEEP_JAR=1 # leave the jar when done?+
-ROOT_FILES="license.txt install.rdf" # put these files in root of xpi+
-#### editable items end+
-TMP_DIR=build.tmp+<pre>
 +#!/bin/bash
 +# build.sh -- builds JAR and XPI files for mozilla extensions
 +# by Nickolay Ponomarev <asqueella@gmail.com>
 +# (original version based on Nathan Yergler's build script)
 +# Most recent version is at <http://kb.mozillazine.org/Bash_build_script>
 + 
 +# This script assumes the following directory structure:
 +# ./
 +# chrome.manifest (optional - for newer extensions)
 +# install.rdf
 +# (other files listed in $ROOT_FILES)
 +#
 +# content/ |
 +# locale/ |} these can be named arbitrary and listed in $CHROME_PROVIDERS
 +# skin/ |
 +#
 +# defaults/ |
 +# components/ |} these must be listed in $ROOT_DIRS in order to be packaged
 +# ... |
 +#
 +# It uses a temporary directory ./build when building; don't use that!
 +# Script's output is:
 +# ./$APP_NAME.xpi
 +# ./$APP_NAME.jar (only if $KEEP_JAR=1)
 +# ./files -- the list of packaged files
 +#
 +# Note: It modifies chrome.manifest when packaging so that it points to
 +# chrome/$APP_NAME.jar!/*
 + 
 +#
 +# default configuration file is ./config_build.sh, unless another file is
 +# specified in command-line. Available config variables:
 +APP_NAME= # short-name, jar and xpi files name. Must be lowercase with no spaces
 +CHROME_PROVIDERS= # which chrome providers we have (space-separated list)
 +CLEAN_UP= # delete the jar / "files" when done? (1/0)
 +ROOT_FILES= # put these files in root of xpi (space separated list of leaf filenames)
 +ROOT_DIRS= # ...and these directories (space separated list)
 +BEFORE_BUILD= # run this before building (bash command)
 +AFTER_BUILD= # ...and this after the build (bash command)
 + 
 +if [ -z $1 ]; then
 + . ./config_build.sh
 +else
 + . $1
 +fi
 + 
 +if [ -z $APP_NAME ]; then
 + echo "You need to create build config file first!"
 + echo "Read comments at the beginning of this script for more info."
 + exit;
 +fi
 + 
 +ROOT_DIR=`pwd`
 +TMP_DIR=build
#uncomment to debug #uncomment to debug
#set -x #set -x
-# remove any left-over files+# remove any left-over files from previous build
-rm $APP_NAME.jar+rm -f $APP_NAME.jar $APP_NAME.xpi files
-rm $APP_NAME.xpi+
rm -rf $TMP_DIR rm -rf $TMP_DIR
-# create xpi directory layout and populate it+$BEFORE_BUILD
-mkdir $TMP_DIR+
-mkdir $TMP_DIR/chrome+
-if [ $HAS_COMPONENTS = 1 ]; then+mkdir --parents --verbose $TMP_DIR/chrome
- mkdir $TMP_DIR/components+
- cp components/* $TMP_DIR/components+
-fi+
-if [ $HAS_DEFAULTS = 1 ]; then+# generate the JAR file, excluding CVS, SVN, and temporary files
- DEFAULT_FILES="`find defaults -path '*CVS*' -prune -o -type f -print | grep -v \~`"+JAR_FILE=$TMP_DIR/chrome/$APP_NAME.jar
- cp --parents $DEFAULT_FILES $TMP_DIR+echo "Generating $JAR_FILE..."
-fi+for CHROME_SUBDIR in $CHROME_PROVIDERS; do
 + find $CHROME_SUBDIR \( -path '*CVS*' -o -path '*.svn*' \) -prune -o -type f -print | grep -v \~ >> files
 +done
 + 
 +zip -0 -r $JAR_FILE -@ < files
 +# The following statement should be used instead if you don't wish to use the JAR file
 +#cp --verbose --parents `cat files` $TMP_DIR/chrome
 + 
 +# prepare components and defaults
 +echo "Copying various files to $TMP_DIR folder..."
 +for DIR in $ROOT_DIRS; do
 + mkdir $TMP_DIR/$DIR
 + FILES="`find $DIR \( -path '*CVS*' -o -path '*.svn*' \) -prune -o -type f -print | grep -v \~`"
 + echo $FILES >> files
 + cp --verbose --parents $FILES $TMP_DIR
 +done
# Copy other files to the root of future XPI. # Copy other files to the root of future XPI.
-cp $ROOT_FILES $TMP_DIR+for ROOT_FILE in $ROOT_FILES install.rdf chrome.manifest; do
 + cp --verbose $ROOT_FILE $TMP_DIR
 + if [ -f $ROOT_FILE ]; then
 + echo $ROOT_FILE >> files
 + fi
 +done
-# generate the JAR file, excluding CVS and temporary files+cd $TMP_DIR
-zip -0 -r $TMP_DIR/chrome/$APP_NAME.jar `find content -path '*CVS*' -prune -o -type f -print | grep -v \~`+ 
-if [ $HAS_LOCALE = 1 ]; then+if [ -f "chrome.manifest" ]; then
- zip -0 -r $TMP_DIR/chrome/$APP_NAME.jar `find locale -path '*CVS*' -prune -o -type f -print | grep -v \~`+ echo "Preprocessing chrome.manifest..."
-fi+ # You think this is scary?
-if [ $HAS_SKIN = 1 ]; then+ #s/^(content\s+\S*\s+)(\S*\/)(.*)$/\1jar:chrome\/$APP_NAME\.jar!\/\2\3/
- zip -0 -r $TMP_DIR/chrome/$APP_NAME.jar `find skin -path '*CVS*' -prune -o -type f -print | grep -v \~`+ #s/^(skin|locale)(\s+\S*\s+\S*\s+)(.*\/)$/\1\2jar:chrome\/$APP_NAME\.jar!\/\3/
 + #
 + # Then try this! (Same, but with characters escaped for bash :)
 + sed -i -r s/^\(content\\s+\\S*\\s+\)\(\\S*\\/\)\(.*\)$/\\1jar:chrome\\/$APP_NAME\\.jar!\\/\\2\\3/ chrome.manifest
 + sed -i -r s/^\(skin\|locale\)\(\\s+\\S*\\s+\\S*\\s+\)\(.*\\/\)$/\\1\\2jar:chrome\\/$APP_NAME\\.jar!\\/\\3/ chrome.manifest
 + 
 + # (it simply adds jar:chrome/whatever.jar!/ at appropriate positions of chrome.manifest)
fi fi
# generate the XPI file # generate the XPI file
-cd $TMP_DIR+echo "Generating $APP_NAME.xpi..."
zip -r ../$APP_NAME.xpi * zip -r ../$APP_NAME.xpi *
-cd .. 
-if [ $KEEP_JAR = 1 ]; then+cd "$ROOT_DIR"
 + 
 +echo "Cleanup..."
 +if [ $CLEAN_UP = 0 ]; then
# save the jar file # save the jar file
mv $TMP_DIR/chrome/$APP_NAME.jar . mv $TMP_DIR/chrome/$APP_NAME.jar .
 +else
 + rm ./files
fi fi
# remove the working files # remove the working files
-rm -rf $TMP_DIR</pre>+rm -rf $TMP_DIR
 +echo "Done!"
 + 
 +$AFTER_BUILD
 +</pre>
 + 
 +Example <tt>config_build.sh</tt> file:
 +<pre>
 +#!/bin/bash
 + 
 +# Build config for the build script, build.sh. Look there for more info.
 + 
 +APP_NAME=helloworld
 +CHROME_PROVIDERS="content locale skin"
 +CLEAN_UP=1
 +ROOT_FILES="readme.txt"
 +ROOT_DIRS=
 +BEFORE_BUILD=
 +AFTER_BUILD=
 +</pre>
 + 
 +== Script 2 ==
 +The extension has to be packed for distribution as .xpi file. To automate this, you can use a small shell script which does the zipping for you:
 + #!/bin/bash
 + buildid=$1
 + <nowiki>[[ "$buildid" == "" ]]</nowiki> && buildid=cvs-`date +%Y%m%d`
 + xpifile=dispmua-$buildid.xpi
 + cd src
 + zip -r ../messenger-dispmua.jar . -x "CVS"
 + cd ..
 + mkdir chrome
 + mv messenger-dispmua.jar chrome/
 + rm "$xpifile"
 + zip "$xpifile" chrome/messenger-dispmua.jar install.rdf
 + rm -r chrome/
 + echo -n Created file:
 + ls "$xpifile"
 +Of course you have to change the jar file name from messenger-dispmua to one matching your extension, but you see how to do it.
 +One more thing: If you pass a parameter to the script, it is taken as the version and appended to the name of the xpi file
 + 
 +[[Category:Development]]

Current revision

This page is part of the extension development documentation project.

Ask your questions in MozillaZine Forums. Also try browsing example code.

Note: development documentation is in process of being moved to Mozilla Development Center (MDC).

Two bash scripts that automate packaging extensions.

Contents

Script 1

Here is a bash script I'm using to package my extensions (under Cygwin). See also Windows build script.

#!/bin/bash
# build.sh -- builds JAR and XPI files for mozilla extensions
#   by Nickolay Ponomarev <asqueella@gmail.com>
#   (original version based on Nathan Yergler's build script)
# Most recent version is at <http://kb.mozillazine.org/Bash_build_script>

# This script assumes the following directory structure:
# ./
#   chrome.manifest (optional - for newer extensions)
#   install.rdf
#   (other files listed in $ROOT_FILES)
#
#   content/    |
#   locale/     |} these can be named arbitrary and listed in $CHROME_PROVIDERS
#   skin/       |
#
#   defaults/   |
#   components/ |} these must be listed in $ROOT_DIRS in order to be packaged
#   ...         |
#
# It uses a temporary directory ./build when building; don't use that!
# Script's output is:
# ./$APP_NAME.xpi
# ./$APP_NAME.jar  (only if $KEEP_JAR=1)
# ./files -- the list of packaged files
#
# Note: It modifies chrome.manifest when packaging so that it points to 
#       chrome/$APP_NAME.jar!/*

#
# default configuration file is ./config_build.sh, unless another file is 
# specified in command-line. Available config variables:
APP_NAME=          # short-name, jar and xpi files name. Must be lowercase with no spaces
CHROME_PROVIDERS=  # which chrome providers we have (space-separated list)
CLEAN_UP=          # delete the jar / "files" when done?       (1/0)
ROOT_FILES=        # put these files in root of xpi (space separated list of leaf filenames)
ROOT_DIRS=         # ...and these directories       (space separated list)
BEFORE_BUILD=      # run this before building       (bash command)
AFTER_BUILD=       # ...and this after the build    (bash command)

if [ -z $1 ]; then
  . ./config_build.sh
else
  . $1
fi

if [ -z $APP_NAME ]; then
  echo "You need to create build config file first!"
  echo "Read comments at the beginning of this script for more info."
  exit;
fi

ROOT_DIR=`pwd`
TMP_DIR=build

#uncomment to debug
#set -x

# remove any left-over files from previous build
rm -f $APP_NAME.jar $APP_NAME.xpi files
rm -rf $TMP_DIR

$BEFORE_BUILD

mkdir --parents --verbose $TMP_DIR/chrome

# generate the JAR file, excluding CVS, SVN, and temporary files
JAR_FILE=$TMP_DIR/chrome/$APP_NAME.jar
echo "Generating $JAR_FILE..."
for CHROME_SUBDIR in $CHROME_PROVIDERS; do
  find $CHROME_SUBDIR \( -path '*CVS*' -o -path '*.svn*' \) -prune -o -type f -print | grep -v \~ >> files
done

zip -0 -r $JAR_FILE -@ < files
# The following statement should be used instead if you don't wish to use the JAR file
#cp --verbose --parents `cat files` $TMP_DIR/chrome

# prepare components and defaults
echo "Copying various files to $TMP_DIR folder..."
for DIR in $ROOT_DIRS; do
  mkdir $TMP_DIR/$DIR
  FILES="`find $DIR \( -path '*CVS*' -o -path '*.svn*' \) -prune -o -type f -print | grep -v \~`"
  echo $FILES >> files
  cp --verbose --parents $FILES $TMP_DIR
done

# Copy other files to the root of future XPI.
for ROOT_FILE in $ROOT_FILES install.rdf chrome.manifest; do
  cp --verbose $ROOT_FILE $TMP_DIR
  if [ -f $ROOT_FILE ]; then
    echo $ROOT_FILE >> files
  fi
done

cd $TMP_DIR

if [ -f "chrome.manifest" ]; then
  echo "Preprocessing chrome.manifest..."
  # You think this is scary?
  #s/^(content\s+\S*\s+)(\S*\/)(.*)$/\1jar:chrome\/$APP_NAME\.jar!\/\2\3/
  #s/^(skin|locale)(\s+\S*\s+\S*\s+)(.*\/)$/\1\2jar:chrome\/$APP_NAME\.jar!\/\3/
  #
  # Then try this! (Same, but with characters escaped for bash :)
  sed -i -r s/^\(content\\s+\\S*\\s+\)\(\\S*\\/\)\(.*\)$/\\1jar:chrome\\/$APP_NAME\\.jar!\\/\\2\\3/ chrome.manifest
  sed -i -r s/^\(skin\|locale\)\(\\s+\\S*\\s+\\S*\\s+\)\(.*\\/\)$/\\1\\2jar:chrome\\/$APP_NAME\\.jar!\\/\\3/ chrome.manifest

  # (it simply adds jar:chrome/whatever.jar!/ at appropriate positions of chrome.manifest)
fi

# generate the XPI file
echo "Generating $APP_NAME.xpi..."
zip -r ../$APP_NAME.xpi *

cd "$ROOT_DIR"

echo "Cleanup..."
if [ $CLEAN_UP = 0 ]; then
  # save the jar file
  mv $TMP_DIR/chrome/$APP_NAME.jar .
else
  rm ./files
fi

# remove the working files
rm -rf $TMP_DIR
echo "Done!"

$AFTER_BUILD

Example config_build.sh file:

#!/bin/bash

# Build config for the build script, build.sh. Look there for more info.

APP_NAME=helloworld
CHROME_PROVIDERS="content locale skin"
CLEAN_UP=1
ROOT_FILES="readme.txt"
ROOT_DIRS=
BEFORE_BUILD=
AFTER_BUILD=

Script 2

The extension has to be packed for distribution as .xpi file. To automate this, you can use a small shell script which does the zipping for you:

#!/bin/bash
buildid=$1
[[ "$buildid" == "" ]] && buildid=cvs-`date +%Y%m%d`
xpifile=dispmua-$buildid.xpi
cd src
zip -r ../messenger-dispmua.jar . -x "CVS"
cd ..
mkdir chrome
mv messenger-dispmua.jar chrome/
rm "$xpifile"
zip "$xpifile" chrome/messenger-dispmua.jar install.rdf
rm -r chrome/
echo -n Created file:
ls "$xpifile"

Of course you have to change the jar file name from messenger-dispmua to one matching your extension, but you see how to do it. One more thing: If you pass a parameter to the script, it is taken as the version and appended to the name of the xpi file