shake

Build system library, like Make, but more accurate dependencies. http://shakebuild.com

Version on this page:0.15.11
LTS Haskell 9.5:0.15.11
Stackage Nightly 2017-09-20:0.15.11
Latest on Hackage:0.16

Shake Hackage version Stackage version Linux Build Status Windows Build Status

Shake is a tool for writing build systems - an alternative to make, Scons, Ant etc. Shake has been used commercially for over five years, running thousands of builds per day. The website for Shake users is at shakebuild.com.

Documentation

  • Why use Shake? Shake lets you write large robust build systems, which deal properly with generated source files and run quickly. If you are writing a custom build system of any moderate size (more than a few rules) you should use Shake. The advantages over other build systems are detailed in the document Why choose Shake?.
  • How do I use Shake? Shake is a Haskell library that you use to define your rules. The Shake manual provides a walk through of a small but realistic example, assuming no Haskell knowledge.
  • Generated documentation for all functions, includes lots of examples.
  • Blog posts detailing ongoing development work.
  • Academic paper on the underlying principles behind Shake.
  • Download the Haskell package from Hackage and install it using Cabal.
  • Mailing list for any questions/bugs/thoughts on Shake. If you need more information and aren't sure where to start, use the mailing list.
  • Questions can be asked on StackOverflow with the tag shake-build-system.

Is your company using Shake? Write something public (even just a tweet to @ndm_haskell) and I'll include a link on the website.

Changes

Changelog for Shake

0.16
#536, make --skip work for oracles
Ensure shakeOutput is used more consistently
#49, add shakeColor and --color flags
#490, recommend -threaded as standard
#517, ignore ./ in FilePattern
Require extra-1.5.3
#499, add a filePattern function, like ?== but with the matches
#474, never spawn user actions unmasked
Allow user arguments to replace builtin arguments
#522, make copyFile create directories if necessary
#516, add an example for withTempDir
#514, expose more about cmd arguments
#523, #524, make sure phony doesn't run its dependencies first
#515, add cmd_ function
#506, allow duplicate type names in different modules
#503, require shakeExtra to obey the sensible invariants
#503, add getShakeExtra/addShakeExtra
#492, fix the single letter flag documentation
Expose 'Process' from Development.Shake
#495, remove dangling link from LICENSE
#436, remove Assume, switch to Rebuild
#419, remove --assume-old and --assume-new, which never worked
Remove support for running Makefile scripts
Add getShakeOptionsRules, to get ShakeOptions in Rules
#479, improve the robustness of the Pool tests
#481, document how to raise errors in Action
Delete the deprecated system* functions
#427, check stored value after checking dependencies
Significant changes to defining custom rules
Delete the deprecated defaultRule
IMPORTANT: Incompatible on disk format change
#428, don't persist errors to the database
0.15.11
#488, make sure parallel tracks dependencies
#513, permit process-1.4.3.0 and above
0.15.10
#465, fix phony names which clash with directories
0.15.9
Documentation tweaks
Optimise the thread pool
Fix progress output through wget
0.15.8
Extra base bounds to rule out building on GHC 7.4
0.15.7
Require extra-1.4.8
#457, better error message when calling need on a directory
#456, use displayException for inner exceptions
Improve the documentation for priority/alternative
#448, fix FSATrace on Mac 10.11
#444, optimise copyFileChanged
#58, change writeFile functions to MonadIO
0.15.6
Require the primitive package
#431, make it an error to need a directory
#393, add orderOnlyAction, a general version of orderOnly
#408, explain that alwaysRerun has no immediate effect
#410, add --digest-not flag to select ChangeModtime
#416, export ShakeValue from the main module only
#352, improve the grammar in the profiling document
#399, explain what in getDirectoryFiles is tracked
#108, add getDirectoryFilesIO, an untracked version
#401, document getDirectoryFiles exception behaviour
#401, fix getDirectoryFiles error on pattern directory missing
#400, detect indirect recursion in build rules
#402, give better errors on recursive rules
#369, clarify the docs for putQuiet/putLoud
#405, make sure phony targets with \ work on Windows
Require extra-1.4.3
#398, only require old-time with GHC 7.4
#239, make Rules an instance of MonadIO
#384, add shakeExtra field to ShakeOptions for user data
#374, make --debug=file write out newlines
#308, make sure Shell and AutoDeps work together
#365, fix unicode output with putNormal
#269, add parallel execution via parallel/forP/par
#310, preserve quoting around cmd
#333, optimise the random pool, up to 20% faster
#335, add deriving Read instances for more types
Add Development.Shake.Forward for forward-defined systems
#336, export :->
#337, fix the docs for &%>
#297, make <enter> run the query profile viewer
#305, make profiling work with newer Chrome
#327, Add AutoDeps feature
#325, add FileStdin to specify the stdin comes from a file
Make an empty Stdin different from no Stdin (inherit) in cmd
#320, add ** as a relative-only alternative to // in patterns
#283, change the semantics of removeFiles, no implicit deletes
#283, speed up getDirectoryFiles on patterns involving literals
Work with stack test
Add RemEnv cmd option
Fix a small space leak on Linux
Fix a space leak in profile summary information
Properly handle *//* in file pattern (at least one directory)
#303, allow ninja rule names to have dots in them
Properly handle /// in file pattern (a wildcard then /)
Make sure Windows separators work in |%> FilePattern rules
#296, fix multifile rules when using --digest-and-input
#286, document the relationship between getEnv and lookupEnv
#285, improve the documentation for phony/alwaysRerun
#284, fix the documentation for normaliseEx
#293, add getProgress
#270, support MonadFix for Rules, allows recursive cache
#295, discount time spent waiting for a cache
#294, give better error messages if you hit GHC bug #10793
#4, add a lock file to stop corrupting databases
0.15.5
#279, make usingConfigFile do a need on the config file
Fix a bug where predicted progress could sometimes be ??
#264, make the the suite more less non-deterministic
0.15.4
Undo a locally modified file
0.15.3
#254, in staunch mode, print out all exceptions
Require extra-1.3
#259, discount time waiting for a resource in profiles
#252, have the docs test configure not in dist
0.15.2
#248, add another example of using cmd
#245, initial support for fsatrace lint checking
Reexport -<.> from filepath where available
Hoogle #106, trigger on filepath version, not GHC version
Add AddEnv and AddPath command options
#243, close fds in child processes when spawning commands
Make Ninja variable handling more accurate
0.15.1
If you have Shakefile.hs, pass it all arguments without interp
Add shakeArgsPrune and shakeArgsPruneWith
#228, allow running cmd async by collecting the ProcessHandle
Make getShakeOptions/processorCount of 0 return the used value
#212, document how to get a full terminal with cmd
#225, warn if there are no want/action statements
#232, don't ignore phony order-only dependencies in Ninja
#226, add escaping for GraphViz labels
#227, add StdinBS for passing a bytestring as Stdin
Make cmd Timeout call terminateProcess as well
0.15
#203, make shakeFiles a directory rather than a file prefix
#220, add getHashedShakeVersion helper
#220, add shakeVersionIgnore to ignore version numbers
#219, run Shakefile.hs from the shake binary
#218, fix issues with incorrect unchanging with no digests
#218, fix issue with ChangeModtimeAndDigest on unchanging files
#216, work around GHC 7.10 RC3 bug 10176
#213, add phonys, a predicate phony rule
Add CmdTime and CmdLine results to cmd/command
Fix parseMakefile for words with multiple escapes in them
#205, add WithStdout, like WithStderr
#27, add support for capturing Stdout/Stderr with bytestrings
Add FileStdout/FileStderr to write a stream direct to a file
#211, add Stdouterr to capture both Stdout and Stderr streams
Require extra-1.1 (to use nubOrd)
Generalise cmd to work with Maybe [String]
Add unit for use with cmd
IMPORTANT: Incompatible on disk format change
#209, improve orderOnly dependencies
0.14.3
Support for the filepath shipped with GHC 7.10
Add Timeout option to command
0.14.2
#198, add <//> operator to join FilePatterns
#198, fix the <.> and other extension methods to work with //
0.14.1
#196, change the links to point at http://www.shakebuild.com/
Improve the error messages when &%> or &?> go wrong
Normalise file patterns used by &?>
0.14
Make FilePattern on Windows cope with all path separators
Rename normalise to normaliseEx
Expose native System.FilePath in Development.Shake.FilePath
#193, eliminate the custom version of </>
#193, make need/orderOnly call normalise on their arguments
#177, use the $PATH variable to resolve cmd
#182, use js-jquery and js-flot
#195, add getConfigKeys
#194, replace *> with %> as the operator for rules
#188, improve the docs on FilePattern
#187, removeFiles on a missing directory should do nothing
#166, add withTempFile and withTempDir in the Action monad
Ensure Ninja response files are always deleted
Fix incorrect units when showing profile to the console
Require the extra library
#178, make --help show the current executable name
0.13.4
#171, fix the --demo mode on Linux
0.13.3
Ensure you wait until the progress thread cleans up
Add --demo mode
Add --progress=record and --progress=replay
Add -j to run with one thread per processor
Fix progress reporting to work even on the first run
Apply abbreviations to staunch failure messages
Fix failure progress messages during staunch mode
#165, make |*> matching with simple files much faster
Add toStandard to the FilePath module
#130, support msvc_deps_prefix in Ninja
#157, allow variable substitution in include/subninja statements
#147, add the version in the profile reports
#147, add --numeric-version flag
#28, switch to continuation passing style, uses far less threads
#156, add readConfigFileWithEnv for configs with an initial env
#129, fix processor count detection on Mac with -threaded
#155, add --live and shakeLiveFiles
#153, handle escaped spaces in parseMakefile
#152, fix typo in the manual
Add copyFileChanged
Fix the leaf column in profile reports
Add Maybe instances for cmd arguments
Add a --profile flag (alias for --report)
Switch to an underlying continuation monad
0.13.2
#95, ensure progress never gets corrupted
#124, add a profile report demo
#128, allow long Ninja command lines
Fix --report=- for builds with no commands in them
0.13.1
Remove all package upper bounds
#126, Ninja compatibility if Ninja fails to create a file
#123, generate Chrome compatible traces
0.13
#122, make --report=- write a report to stdout
Improve the profile report summary
#122, turn shakeReport into a list of files, instead of a Maybe
#60, improve how command lines are printed out
#113, print info about copyFile' and removeFilesAfter at -V
Replace **> with |*> , ?>> with &?> and *>> with &*>
IMPORTANT: Incompatible on disk format change
#83, support digest rules for files
#83, add shakeChange parameter and --digest* args
#83, add equalValue function to Rule typeclass
Deprecate defaultRule
Make literal *> matches take precedence over wildcard matches
#120, add a priority function
0.12
#62, move to a ReaderT/IORef for the Action monad
Add DEPRECATED pragmas on system' calls
Delete Development.Shake.Sys, use command or cmd instead
Add a 'console' pool to Ninja
Avoid using System.Cmd (deprecated in GHC HEAD)
#41, use higher precision file times on POSIX
#117, use higher precision times for Unicode files on Windows
#118, add support for Ninja -t compdb
#119, more test fixes for Linux GHC 7.8
0.11.7
#119, test fixes for Linux GHC 7.8
0.11.6
#114, run build.sh in the test suite with sh
#115, fix the test suite on Linux GHC 7.8
#116, fix for GHC 7.10
0.11.5
Include the sources for flot and jQuery in the dist tarball
Note that .. in FilePattern values is unlikely to be correct
#109, make removeFiles delete directories that match
#84, make removeFiles not delete empty unmatched directories
#111, fixes to the user manual
#110, don't give a warning if -threaded is turned off
#103, don't suggest -qg and -qb, they fail without -threaded
#102, fix up </> when the LHS starts with .
0.11.4
Work with QuickCheck-2.7 (which defines ===)
#100, handle GraphViz missing gracefully
Fix up the profiling report generation
#99, add getEnvWithDefault
0.11.3
#97, fix a serialisation bug when > 254 arguments to need
0.11.2
#96, fix a bug in addPath that caused $PATH to be added twice
0.11.1
#94, GHC 7.8 support
Add a Config module
#89, support :: as a build rule separator
0.11
Add alternatives to allow overlapping rules
Make storedValue take a ShakeOptions structure
Generalise the newCache function
Improve the performance of the Ninja parser
Make the database more compact
#84, ensure you normalise removeFile patterns first
#82, make -j0 guess at the number of processors
#81, add --lint-tracker to use tracker.exe
Add trackRead, trackWrite
Add trackUse, trackChange, trackAllow
#85, move rule creation functions into Development.Shake.Rule
Mark Development.Shake.Sys as DEPRECATED with a pragma
Change shakeLint to be of type Maybe Lint, instead of Bool
#50, add shakeArgsAccumulate
0.10.10
Improve Ninja --lint checking
0.10.9
#76, add Ninja specific lint checking
#75, add orderOnly dependencies
#76, add needed, to assert a need doesn't rebuild
#78, don't use cabal in the test suite
#77, add shakeRunCommands and --skip-commands
#67, add withVerbosity
#51, add getShakeOptions
Lots of Haddock improvements
Deprecate system', use cmd or command instead
#53, add addPath and addEnv to modify environment variables
Make all search path things return the native separators
#73, if Haskell can't write a unicode filename, skip the test
Print out the entire database in diagnostics mode
Rewrite database writes, old code could break metadata on error
#25, optimise building with Ninja
Fix many bugs in FilePath.normalise
Require QuickCheck-2.0 or higher
Change how the makefile parser treats \ characters
Add a --no-build flag
#74, allow cmd to be used with result IO
Add a Util module, with Makefile parsing
0.10.8
Allow unix-1.5.1 again
Require Cabal 1.10 or above
Convert to the cabal test compatible test suite
0.10.7
Support time-1.2
#71, fix a bug when requesting all three outputs from command
#64, add progressProgram and use it in progressSimple
Remove isRunning, kill the progress thread on completion
#47, improve the performance of ?==, especially on "//*"
#68, improve the docs for addOracle
#55, ensure if you need phony targets you rebuild every time
#52, ensure all command output is printed
#20, document preferred compilation flags
#20, speed up the Shake executable with GHC RTS flags
#39, print out more of the version string on database change
#41, require unix-2.6 or above
#48, make it clear filetimes are hashes
#43, improve the error messages on lint failures
#45, avoid use of nub
#45, avoid use of intersect which is O(n^2)
#26, add newThrottle to create throttling resources
#26, add unsafeExtraThread to run more than shakeThreads
#32, add a check that withResources does not call need
#614, support unicode filenames
Require unordered-containers-0.2.1 or above
Reduce stack usage when lint checking
#24, create the output directories for the multiple file rule
Improvements to match Ninja behaviour
0.10.6
Include command/cmd in the default module
#16, change the scoping in subninja
#15, fix up the Ninja default targets
Fix up --version output
0.10.5
Improve progress prediction for the first build
Fix removeFiles when there is a directory argument and a pattern
Delete shakeDeterministic, shakeThreads=1 has the same effect
0.10.4
Fix writeFileChanged for line endings on Windows
Support arguments to --progress
Set the number of capabilities based on -j flags
Add shakeTimings, to time the separate stages
Add AssumeSkip, mostly for benchmarking
Normalise file arguments before calling want
Expose ShakeException
Add isFailure to ShakeProgress, and display in progressDisplay
Add withResources
Add -<.> alias for replaceExtension
Add selectors on Stdout/Stdin/Exit
Add CmdResult instance for ExitCode
0.10.3
Upgrade to Flot-0.8
Small documentation markup fixes
0.10.2
Require process-1.1 or above
Improve progress guesses (use exponential decay of work rate)
Improve profiling report error messages
Add a Command module, with alternatives to system' etc.
#593, don't assume doesDirectoryExist = not . doesFileExist
#594, swap how traced messages are printed out
Add Chatty verbosity, for what was Loud
Make repeated --verbose keep increasing the verbosity
If shakeThreads==1 then always use a deterministic pool
Add shakeLineBuffering, defaulting to True
Improve the performance of profiling
Documentation and corrections improvements
Eliminate StepKey from the profiling output
Add a --no-time flag
Makefile improvements
Avoid use of ghc-options in .cabal file
0.10.1
Allow the shake executable to build
0.10
Add phony, for writing phony actions
Add removeFilesAfter
Switch to the new profiling code
Add actionOnException and actionFinally
Add shakeArgsWith
Rename shakeWithArgs to shakeArgs and change the clean argument
Remove the -f alias for --flush
Add a shake executable which runs Makefiles
Rename shake to shake-test
Change how progress messages are written
Do not write a beep in progressDisplay, avoids a beep
Add exe function to FilePath
0.9.1
GHC head (7.7) compatibility by removing the Rules fundep
0.9
Make the tests work on Linux
Fix report generation on machines whose text format is not ASCII
Make Directory functions work the same on Linux/Mac
Change shakeVersion to be a String
Stop alwaysRerun causing lint failures
Make shakeLint check that the current directory does not change
Add shakeOutput setting
Add removeFiles function
Add Sys module for writing consise system calls
Add getEnv function
Add shakeWithArgs and shakeOptDescrs
Add newCache to cache the parsed contents of files
Add newResourceIO and move newResource into the Rules monad
Add shakeStorageLog, to help diagnosing obscure database errors
0.8
Improve the Oracle documentation
Allow getDirectoryFiles to operate recursively
0.7
Change getDirectoryFiles to take a set of file patterns
Add doesDirectoryExist function
Add shakeAbbreviations feature
Add a new Progress module for sensible progress messages
Spawn shakeProgress on a separate thread, a safer default
Improve the runtime error messages
Add a quietly function, to hide traced commands
Print main status messages when running a traced command
Display the exit code when a system command fails
Fix AssumeClean when the result exists but has never been built
IMPORTANT: Incompatible on disk format change
Change the storage to not write messages on --silent
Add Applicative on Rules
Add Applicative on Action
0.6
Make addOracle return a result of askOracle
Export the class bodies from Classes
Don't export ShakeValue from Classes
0.5
IMPORTANT: Incompatible on disk format change
Add the ShakeValue constraint synonym
Change the Oracle to be strongly typed
Add a Classes module
0.4
Add shakeFlush to control how often flush is called
Fix a serious space leak in the thread pool
#502, add shakeAssume to assume files are clean/dirty
Remove validStored, replace with storedValue
Remove the default validStored class, almost never right
Remove Eq/Ord from ShakeOptions (now contains a func)
#501, add statistics gathering functions to help report progress
Ensure registering witnesses is thread safe
Ensure GHC does not over-optimise type registration
0.3.10
Add Paths.hs so you can run the tests from the tarball
0.3.9
Don't rely on toList returning a consistent order
Allow hashable-1.2
0.3.8
Fix up FilePattern so "foo//bar" ?== "foo/bar"
0.3.7
Update the cabal file
0.3.6
Add addOracles, for implementing more advanced oracles
Add withoutActions, for implementing command line arguments
0.3.5
#571, vastly improve the correctness of FilePattern
#574, documentation typos
Expose rulePriority
0.3.4
Update documentation with links to ICFP 2012 paper/talk
0.3.3
Minor refactorings
0.3.2
Fix cabal specification on non-Windows
0.3.1
Don't use syntax also stolen by QuasiQuotes
Avoid warnings about unused monadic values
Fix up getModificationTime for GHC 7.6
Don't assume catch is exported by Prelude (GHC 7.6 compat)
Improve the error message when failing to build with *>> or ?>>
Introduce a portable flag, to switch to portable FileTime ops
Improve the error message when failing to build a file
Ensure errors raised bubble up quickly
Significant improvements to the profile output
Only trace the program name by default, not the entire command
Allow unordered-containers < 0.2 again
Intern all keys, so they are only stored once
Optimise modification time checking on Unix
Optimise modification time checking on Windows
Make some fields smaller on disk
IMPORTANT: Incompatible on disk format change
Switch to ByteString for storing File
Add shakeDeterministic, along with a default random pool
Make the Monad/Monoid instance for Rules strict
0.3
#550, ensure the journal thread is locked
#550, if your thread dies while reading the database then die
#550, ensure you reset to before the slop before writing
If the witness table is completely corrupt give a better error
Make storage work with exceptions whose messages raise errors
Journal error conditions, to ensure they don't repeat
Better messages on invalid database versions
Complete rewrite of the storage layer and journal design
IMPORTANT: Incompatible on disk format change
0.2.11
IMPORTANT: #546, don't save the database to where it was created
0.2.10
Add systemCwd for running with a particular current directory
Ensure the database is saved to where it was created
#545, make sure if shake is killed, it kills its children
0.2.9
Require unordered-containers 2.1 or higher, fixes bugs
Allow transformers-0.3.*
Add a random script generator and tester
Improve the documentation for withResource
Fix the unordered-containers constraint, was too loose
Don't write report generation messages in Quiet mode
Add ?>> operator, a generalisation of *>>
0.2.8
Rename shakeDump to shakeReport
Add profile report generator
0.2.7
#530, require unordered-containers >= 0.1.4.3
0.2.6
Improve the documentation code fragments (more links)
Add support for managing finite resources
0.2.5
Require hashable-1.1.2.3, which has a TypeRep instance
Add Data/Typeable instances for ShakeOptions
Add Data instance for Verbosity
0.2.4
Include the C example source files
Significant documentation improvements
0.2.3
Create the shakeFiles directory if missing
0.2.2
Allow deepseq-1.3.*
Add a basic lint checking mode
Remove the Dirty state entirely (was incorrect)
0.2.1
Put diagnostics in more places
Add a C example
0.2
Add shakeStaunch
Rename shakeParallel to shakeThreads
Delete the lint support (never actually worked)
Completely rewrite the central build algorithm
Add verbosity Diagnostic
Improve FilePath.normalise
Add writeFileChanged
Add systemOutput
Add an Oracle module
Add an explicit Verbosity type
Change to lower precedence for *> etc
0.1.5
Allow deepseq-1.2
0.1.4
Don't export currentRule/currentStack
Fix **>, was matching the wrong way round
Fix FilePath normalise so it works properly on Windows
Properly detect recursive rules, instead of looping
Add *>> for building multiple files at once
0.1.3
Fix a bug where a file rule could return with a lazy error
Make sure all the files are stored in binary, not text
Fix a pattern match error in getDirectoryFiles
0.1.2
Add a warning in the description
0.1.1
Significantly improved documentation
system' now takes an initial argument for the program
0.1
Many changes to signatures, some basic documentation
Additional demo, to build shake itself
0.0
Initial version, not ready for public use
comments powered byDisqus