Include documentation in binary tarballs/zips

Author: borsboom

doc/install_and_upgrade.md

@@ -5,14 +5,16 @@ Binaries are signed with this [[Signing key]].
 ## Windows
 
 * Download [the latest release](https://github.com/commercialhaskell/stack/releases/latest). Note: while generally i386/32-bit GHC is better tested on Windows, there are reports that recent versions of Windows only work with the 64-bit version of stack (see [issue #393](https://github.com/commercialhaskell/stack/issues/393)).
-* Unpack the archive (you may need to rename the contents to `stack.exe`) and place `stack.exe` somewhere on your `%PATH%` (see [Path section below](#path)) and you can then run `stack` on the command line.
+* Unpack the archive and place `stack.exe` somewhere on your `%PATH%` (see [Path section below](#path)) and you can then run `stack` on the command line.
+* Now you can run `stack` from the terminal.
 
 NOTE: These executables have been built and tested on a Windows 7, 8.1, and 10 64-bit machines. They should run on older Windows installs as well, but have not been tested. If you do test, please edit and update this page to indicate as such.
 
 ## OS X
 
 * Download [the latest release](https://github.com/commercialhaskell/stack/releases/latest)
-* Extract the `stack` executable and put it somewhere on your `$PATH` (see [Path section below](#path))
+* Extract the archive and place `stack` somewhere on your `$PATH` (see [Path section below](#path))
+* Now you can run `stack` from the terminal.
 
 We generally test on the current version of OS X, but stack is known to work on Mavericks as well, and may also work on older versions (YMMV).
 
@@ -153,7 +155,7 @@ Alternatively, the package can be built from source as follows.
 (64-bit and 32-bit options available)
 
 * Download [the latest release](https://github.com/commercialhaskell/stack/releases/latest).  Note: the `-gmp4` variants are for older distributions (such as CentOS 6.x) that only include libgmp4 (libgmp.so.3).
-* The download is compressed. Extract the compressed file somewhere on your PATH  (see [PATH section below](#path)).
+* Extract the archive and place `stack` somewhere on your `$PATH` (see [Path section below](#path))
 * Now you can run `stack` from the terminal.
 
 Tested on Fedora 20: make sure to install the following packages `sudo yum install perl make automake gcc gmp-devel`.

scripts/release/release.hs

@@ -158,28 +158,41 @@ rules global@Global{..} args = do
             (do opt <- addPath [installBinDir] []
                 () <- cmd opt stackProgName (stackArgs global) "build --pedantic --haddock --no-haddock-deps"
                 () <- cmd opt stackProgName (stackArgs global) "clean"
-                () <- cmd opt stackProgName (stackArgs global) "build"
-                () <- cmd opt stackProgName (stackArgs global) "test --flag stack:integration-tests"
+                () <- cmd opt stackProgName (stackArgs global) "build --pedantic"
+                () <- cmd opt stackProgName (stackArgs global) "test --pedantic --flag stack:integration-tests"
                 return ())
             (renameFile tmpExeFile instExeFile)
         copyFileChanged (installBinDir </> stackOrigExeFileName) out
 
     releaseDir </> binaryExeZipFileName %> \out -> do
-        need [releaseDir </> binaryExeFileName]
-        putNormal $ "zip " ++ (releaseDir </> binaryExeFileName)
+        stageFiles <- getStageFiles
+        putNormal $ "zip " ++ out
         liftIO $ do
-            entry <- Zip.readEntry [] (releaseDir </> binaryExeFileName)
-            let entry' = entry{Zip.eRelativePath = binaryExeFileName}
-                archive = Zip.addEntryToArchive entry' Zip.emptyArchive
+            entries <- forM stageFiles $ \stageFile -> do
+                Zip.readEntry
+                    [Zip.OptLocation
+                        (dropDirectoryPrefix (releaseDir </> binaryExeStageDirName) stageFile)
+                        False]
+                    stageFile
+            let archive = foldr Zip.addEntryToArchive Zip.emptyArchive entries
             L8.writeFile out (Zip.fromArchive archive)
 
     releaseDir </> binaryExeTarGzFileName %> \out -> do
-        need [releaseDir </> binaryExeFileName]
-        putNormal $ "tar gzip " ++ (releaseDir </> binaryExeFileName)
+        stageFiles <- getStageFiles
+        putNormal $ "tar gzip " ++ out
         liftIO $ do
-            content <- Tar.pack releaseDir [binaryExeFileName]
+            content <- Tar.pack releaseDir $
+                map (dropDirectoryPrefix releaseDir) stageFiles
             L8.writeFile out $ GZip.compress $ Tar.write content
 
+    releaseDir </> binaryExeStageDirName </> binaryExeFileName %> \out -> do
+        copyFile' (releaseDir </> binaryExeFileName) out
+
+    releaseDir </> (binaryExeStageDirName ++ "//*") %> \out -> do
+        copyFile'
+            (dropDirectoryPrefix (releaseDir </> binaryExeStageDirName) out)
+            out
+
     releaseDir </> binaryExeFileName %> \out -> do
         need [installBinDir </> stackOrigExeFileName]
         case platformOS of
@@ -202,7 +215,7 @@ rules global@Global{..} args = do
 
     installBinDir </> stackOrigExeFileName %> \_ -> do
         alwaysRerun
-        cmd stackProgName (stackArgs global) "build"
+        cmd stackProgName (stackArgs global) "build --pedantic"
 
     forM_ distros $ \distro0 -> do
 
@@ -256,6 +269,16 @@ rules global@Global{..} args = do
         writeFileChanged out =<< readTemplate (distroTemplateDir dvDistro </> "docker/run.sh")
 
   where
+
+    getStageFiles = do
+        docs <- getDirectoryFiles rootDir
+            ["LICENSE", "*.md", "doc//*"]
+        let stageFiles = concat
+                [[releaseDir </> binaryExeStageDirName </> binaryExeFileName]
+                ,map ((releaseDir </> binaryExeStageDirName) </>) docs]
+        need stageFiles
+        return stageFiles
+
     distroVersionFromPath path =
         case stripPrefix (releaseDir ++ "/") path of
             Nothing -> error ("Cannot determine Ubuntu version from path: " ++ path)
@@ -284,6 +307,7 @@ rules global@Global{..} args = do
             _ -> binaryExeTarGzFileName
     binaryExeZipFileName = binaryName global <.> zipExt
     binaryExeTarGzFileName = binaryName global <.> tarGzExt
+    binaryExeStageDirName = binaryName global
     binaryExeFileName = stackOrigExeFileName
     stackOrigExeFileName = stackProgName <.> exe
     distroPackageFileName distro
@@ -457,6 +481,14 @@ callGithubApi Global{..} headers mpostFile url = do
         res <- http req manager
         responseBody res $$+- CC.sinkLazy
 
+-- | Drops a directory prefix from a path.  The prefix automatically has a path
+-- separator character appended.  Fails if the path does not begin with the prefix.
+dropDirectoryPrefix :: FilePath -> FilePath -> FilePath
+dropDirectoryPrefix prefix path =
+    case stripPrefix (prefix ++ "/") path of
+        Nothing -> error ("dropDirectoryPrefix: cannot drop " ++ show prefix ++ " from " ++ show path)
+        Just stripped -> stripped
+
 -- | Build a Docker image and write its ID to a file if changed.
 buildDockerImage :: FilePath -> String -> FilePath -> Action String
 buildDockerImage buildDir imageTag out = do
@@ -497,6 +529,10 @@ platformOS =
 releaseDir :: FilePath
 releaseDir = "_release"
 
+-- | Root directory of the project
+rootDir :: FilePath
+rootDir = "."
+
 -- | @GITHUB_AUTH_TOKEN@ environment variale name.
 githubAuthTokenEnvVar :: String
 githubAuthTokenEnvVar = "GITHUB_AUTH_TOKEN"