`build`: functions module for shellfire

This module provides a small framework for making it straightforward to build, fatten and swaddle shellfire applications. Unlike traditional build tools, it provides full access to a rich runtime library - shellfire and all its modules. A generic build script is supplied (build) that, together with an user-defined file build.shellfire, can be used to rapidly create build scripts. This file is idential to normal shellfire application logic - reference other modules, call functions, create functions, do whatever you want. The included functions can also be used standalone.

An example user is shellfire.

Code may change as usage expands.

Compatibility

Tag release_2015.0117.1750-1 is compatible with shellfire release release_2015.0117.1750-1.

Overview

Quick Tutorial

Do the following from the top-level folder of your git repository:-

# Add this as a submodule (Importing)
mkdir -m 0755 -p lib/shellfire
cd lib/shellfire
git submodule add --branch master "https://github.com/shellfire-dev/build.git"
cd -

# Symlink the build script
ln -s lib/shellfire/build/build

# Create some build rules
cat >build.shellfire <<-EOF
build()
{
	# Create a folder called 'output'
	build_prepareOutput
	
	core_message NOTICE "Hello World"
}
EOF

# Ignore output folder created by `build_prepareOutput`
printf '\n%s\n' "output" >>.gitignore

# Run the build!
./build

Build scripts are regular shellfire applications; for example, run ./build --help to see a list of options. Consequently, you could add functions (just prefix them so they don't collide with the build namespace - _program is appropriate), even add additional shellfire modules - anything a shellfire application can do, build scripts can do. And if you come up with something good, please consider pushing a pull request.

When adding functions, you can them either to build.shellfire or even create your own modules in lib/shellfire, and use core_usesIn module_name to import it.

Build with swaddle Tutorial

The build module contains a wrapper around fatten and swaddle. Setting it up requires us to:-

Completed the Quick Tutorial
Import fatten
Import swaddle
Adjust the build rules
Add swaddling
Add a README.md and COPYRIGHT file, if not already present.
build!

For the purposes of this tutorial, we'll assume you've set up the following environment variables:-

# eg shellfire-dev, raphaelcohn, etc
mygithubuser=MY_GITHUB_USER_OR_ORGANIZATION

# eg For the overdrive tutorial, overdrive.
myproject=MY_PROJECT_NAME

# eg For the overdrive tutorial, overdrive.
myprogram=MY_PROGRAM_TO_FATTEN

Import fatten

There are three ways to import fatten:-

By downloading a executable release, and adding it as an executable at tools/fatten/fatten
By relying on your package manager
By importing it as a submodule

Since releases of fatten have shellfire's automatic dependency installation disabled, it is preferable for this tutorial to use the submodule. This ensures the build system installs what it needs on first run. Let's add it:-

mkdir -m 0755 -p tools
cd tools
git submodule add --branch master "https://github.com/shellfire-dev/fatten.git"
git submodule init
git submodule update --init --recursive
cd -

This tracks fatten's master branch. To fix to a particular release of fatten, such as release_2015.0116.1415-1:-

# Assuming the steps above have been taken
cd tools/fatten
git checkout release_2015.0116.1415-1
cd -

Import swaddle

Similarly to fatten, for swaddle, there are three ways to import it. Again, we'll add it as a submdoule:-

cd tools
git submodule add --branch master "https://github.com/raphaelcohn/swaddle.git"
git submodule init
git submodule update --init --recursive
cd -

This tracks swaddle's master branch. To fix to a particular release of swaddle, such as release_2015.0117.1737-2:-

# Assuming the steps above have been taken
cd tools/swaddle
git checkout release_2015.0117.1737-2
cd -

Adjust the build rules

Do the following from the top-level folder of your git repository (make sure you have set the environment variables first):-

cat >build.shellfire <<-EOF
build()
{
	build_prepareOutput
	
	build_fattenAndSwaddle '${myproject}' "\$build_relativePath" '${myprogram}'
}
EOF

Add swaddling

swaddling is the name swaddle gives to the source control-friendly configuration of files and folders that create packages, repositories and web sites hosting your released code. Let's create some (make sure you have set the environment variables first):-

# If a folder is present, that package kind is built
mkdir -m 0755 -p swaddling/"$myproject"/{tar,deb,skeleton}/all

## Useful configuration
cat >swaddling/swaddling.conf <<-EOF
    configure swaddle host_base_url 'https://${mygithubuser}.github.io/${myproject}/download'
    configure swaddle bugs_url 'https://github.com/$mygithubuser/${myproject}/issues'
    configure swaddle maintainer_name 'Raphael Cohn'
    configure swaddle maintainer_comment 'Package Signing Key'
    configure swaddle maintainer_email 'raphael.cohn@stormmq.com'
    configure swaddle sign no
    configure swaddle vendor ${mygithubuser}
EOF

## Package descriptions and summaries
cat >swaddling/"$myproject"/package.conf <<-EOF
    configure swaddle_package description \
    "${myproject} is a tutorial application
    The first line is used as a summary by RPM."
EOF

## Debian packages depending on dash, compressed using gzip
cat >swaddling/"$myproject"/deb/deb.conf <<-EOF
    configure swaddle_deb depends dash
    configure swaddle_deb depends coreutils
    configure swaddle_deb compression gzip
EOF

## gzip, xz compressed tarballs
cat >swaddling/"$myproject"/tar/tar.conf <<-EOF
    configure swaddle_tar compressions gzip
    configure swaddle_tar compressions xz
EOF

# gitignore s

## Make sure empty folders get checked in
touch swaddling/"$myproject"/{tar,deb,skeleton}/all/.gitignore

## build also creates a symlink at `swaddling/$myproject/body`, so let's add that to `.gitignore`:-
printf '\n%s\n' 'body' >swaddling/"$myproject"/.gitignore

Add a `README.md` and `COPYRIGHT` file, if not already present.

swaddle automatically converts README.md files into a man page for your package. Let's make sure at least an empty one exists:-

touch README.md

Both fatten and swaddle use a COPYRIGHT file, in Machine-readable Debian format, to embed licensing and COPYRIGHT information in your package (eg RPM licence fields and documentation database, Debian documentation, etc). These are much more precise than the usual mix of a LICENSE file and copyright headers in source files (and much easier to maintain). As an example, why not modify ours:-

cat >COPYRIGHT <<EOF
Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Comment: Distribution Compilation Copyright and License
Copyright: Copyright © 2014-2015, Raphael Cohn <raphael.cohn@stormmq.com>
License: MIT
 The MIT License (MIT)
 .
 Copyright © 2014-2015, Raphael Cohn <raphael.cohn@stormmq.com>
 .
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 .
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 .
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

Files: *
Copyright: Copyright © 2014-2015, Raphael Cohn <raphael.cohn@stormmq.com>
License: MIT
 The MIT License (MIT)
 .
 Copyright © 2014-2015, Raphael Cohn <raphael.cohn@stormmq.com>
 .
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 .
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 .
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
EOF

build!

Right, now just build and see what happens:-

./build

Global Variables

The global array variable build_nonOptions contains all non-options (ie things after switches / --). The shellfire build uses this variable to decide which components to build.

Notes

Please note that the symlink build.shellfire.functions intentionally appears broken.

Importing

To import this module, add a git submodule to your repository. From the root of your git repository in the terminal, type:-

mkdir -p lib/shellfire
cd lib/shellfire
git submodule add "https://github.com/shellfire-dev/build.git"
cd -
git submodule init --update

You may need to change the url https://github.com/shellfire-dev/build.git above if using a fork.

You will also need to add paths - include the module paths.d.

Namespace `build`

To use in code

If calling from another shellfire module, add to your shell code the line

core_usesIn build

in the global scope (ie outside of any functions). A good convention is to put it above any function that depends on functions in this module. If using it directly in a program, put this line inside the _program() function:-

_program()
{
	core_usesIn build
	…
}

Functions

`build_prepareOutput()`

Takes no parameters.

Creates an output folder at build_outputPath, which, by default, is $(pwd)/output but can be overridden by build --output-path.

`build_fattenAndSwaddle()`

Parameter	Value	Optional
`swaddleName`	Name of the swaddle to use.	No
`repositoryPath`	Path to repository.	No
`…`	One or more shellfire applications (files) to fatten	Yes, but please supply at least one to be useful!

This function fattens one or more shellfire applications at repositoryPath before swaddleing them with a swaddle swaddleName at repositoryPath/swaddling/swaddleName. Output is written to build_outputPath/fattened and build_outputPath/swaddled. Since swaddleing also tags and publishes to GitHub releases (but not, as yet, pages), this also does a release.

Before calling this function, you should prepare any other output in the body folders of the swaddle.

Additionally, a Debian format COPYRIGHT file is expected at repositoryPath.

Commonly, "$build_relativePath" is passed for repositoryPath.

Namespace `build_travis_ci`

Please note, Travis CI doesn't play nicely with swaddle at this time. swaddle uses GPG and has its own concepts of release, etc, which, in our view, are far more useful than the Travis CI approach. Opinions will differ, but we should think of Continuous Deployment as the new normal, and script for it, rather than separately. Build artifacts should become a thing of the past, of no more importance than temp files.

To use in code

If calling from another shellfire module, add to your shell code the line

core_usesIn build/travis ci

_program()
{
	core_usesIn build/travis ci
	…
}

Functions

`build_travis_ci_isExecuting()`

Takes no arguments.

Returns a zero value if Travis CI is executing, or non-zero if not.

`build_travis_ci_do()`

Parameter	Value	Optional
`…`	A command line consisting of a function name and arguments to pass to it.	No

Executes the passed command line if Travis CI is executing.

`build_travis_ci_updateGitSubmodulesRecursively()`

Takes no arguments.

Attempts to update git submodules recursively in Travis CI environment. Highly experimental, subject to change.

`build_travis_ci_ensureGnupgKeyringExists()`

Takes no arguments.

Attempts to ensure GPG keyring folder exists. Highly experimental, subject to change.

shellfire-dev/build

build: functions module for shellfire

Compatibility

Overview

Quick Tutorial

Build with swaddle Tutorial

Import fatten

Import swaddle

Adjust the build rules

Add swaddling

Add a README.md and COPYRIGHT file, if not already present.

build!

Global Variables

Notes

Importing

Namespace build

To use in code

Functions

build_prepareOutput()

build_fattenAndSwaddle()

Namespace build_travis_ci

To use in code

Functions

build_travis_ci_isExecuting()

build_travis_ci_do()

build_travis_ci_updateGitSubmodulesRecursively()

build_travis_ci_ensureGnupgKeyringExists()

`build`: functions module for shellfire

Add a `README.md` and `COPYRIGHT` file, if not already present.

Namespace `build`

`build_prepareOutput()`

`build_fattenAndSwaddle()`

Namespace `build_travis_ci`

`build_travis_ci_isExecuting()`

`build_travis_ci_do()`

`build_travis_ci_updateGitSubmodulesRecursively()`

`build_travis_ci_ensureGnupgKeyringExists()`