releaser (empty) → 0.1.0.0
raw patch · 6 files changed
+474/−0 lines, 6 filesdep +Cabaldep +basedep +pretty-terminalsetup-changed
Dependencies added: Cabal, base, pretty-terminal, process, regex-pcre, releaser
Files
- CHANGELOG.md +5/−0
- LICENSE +202/−0
- Setup.hs +2/−0
- releaser.cabal +39/−0
- releaser/Main.hs +27/−0
- src/Releaser/Primitives.hs +199/−0
+ CHANGELOG.md view
@@ -0,0 +1,5 @@+# Revision history for releaser++## 0.1.0.0 -- YYYY-mm-dd++* First version. Released on an unsuspecting world.
+ LICENSE view
@@ -0,0 +1,202 @@++ Apache License+ Version 2.0, January 2004+ http://www.apache.org/licenses/++ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION++ 1. Definitions.++ "License" shall mean the terms and conditions for use, reproduction,+ and distribution as defined by Sections 1 through 9 of this document.++ "Licensor" shall mean the copyright owner or entity authorized by+ the copyright owner that is granting the License.++ "Legal Entity" shall mean the union of the acting entity and all+ other entities that control, are controlled by, or are under common+ control with that entity. For the purposes of this definition,+ "control" means (i) the power, direct or indirect, to cause the+ direction or management of such entity, whether by contract or+ otherwise, or (ii) ownership of fifty percent (50%) or more of the+ outstanding shares, or (iii) beneficial ownership of such entity.++ "You" (or "Your") shall mean an individual or Legal Entity+ exercising permissions granted by this License.++ "Source" form shall mean the preferred form for making modifications,+ including but not limited to software source code, documentation+ source, and configuration files.++ "Object" form shall mean any form resulting from mechanical+ transformation or translation of a Source form, including but+ not limited to compiled object code, generated documentation,+ and conversions to other media types.++ "Work" shall mean the work of authorship, whether in Source or+ Object form, made available under the License, as indicated by a+ copyright notice that is included in or attached to the work+ (an example is provided in the Appendix below).++ "Derivative Works" shall mean any work, whether in Source or Object+ form, that is based on (or derived from) the Work and for which the+ editorial revisions, annotations, elaborations, or other modifications+ represent, as a whole, an original work of authorship. For the purposes+ of this License, Derivative Works shall not include works that remain+ separable from, or merely link (or bind by name) to the interfaces of,+ the Work and Derivative Works thereof.++ "Contribution" shall mean any work of authorship, including+ the original version of the Work and any modifications or additions+ to that Work or Derivative Works thereof, that is intentionally+ submitted to Licensor for inclusion in the Work by the copyright owner+ or by an individual or Legal Entity authorized to submit on behalf of+ the copyright owner. For the purposes of this definition, "submitted"+ means any form of electronic, verbal, or written communication sent+ to the Licensor or its representatives, including but not limited to+ communication on electronic mailing lists, source code control systems,+ and issue tracking systems that are managed by, or on behalf of, the+ Licensor for the purpose of discussing and improving the Work, but+ excluding communication that is conspicuously marked or otherwise+ designated in writing by the copyright owner as "Not a Contribution."++ "Contributor" shall mean Licensor and any individual or Legal Entity+ on behalf of whom a Contribution has been received by Licensor and+ subsequently incorporated within the Work.++ 2. Grant of Copyright License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ copyright license to reproduce, prepare Derivative Works of,+ publicly display, publicly perform, sublicense, and distribute the+ Work and such Derivative Works in Source or Object form.++ 3. Grant of Patent License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ (except as stated in this section) patent license to make, have made,+ use, offer to sell, sell, import, and otherwise transfer the Work,+ where such license applies only to those patent claims licensable+ by such Contributor that are necessarily infringed by their+ Contribution(s) alone or by combination of their Contribution(s)+ with the Work to which such Contribution(s) was submitted. If You+ institute patent litigation against any entity (including a+ cross-claim or counterclaim in a lawsuit) alleging that the Work+ or a Contribution incorporated within the Work constitutes direct+ or contributory patent infringement, then any patent licenses+ granted to You under this License for that Work shall terminate+ as of the date such litigation is filed.++ 4. Redistribution. You may reproduce and distribute copies of the+ Work or Derivative Works thereof in any medium, with or without+ modifications, and in Source or Object form, provided that You+ meet the following conditions:++ (a) You must give any other recipients of the Work or+ Derivative Works a copy of this License; and++ (b) You must cause any modified files to carry prominent notices+ stating that You changed the files; and++ (c) You must retain, in the Source form of any Derivative Works+ that You distribute, all copyright, patent, trademark, and+ attribution notices from the Source form of the Work,+ excluding those notices that do not pertain to any part of+ the Derivative Works; and++ (d) If the Work includes a "NOTICE" text file as part of its+ distribution, then any Derivative Works that You distribute must+ include a readable copy of the attribution notices contained+ within such NOTICE file, excluding those notices that do not+ pertain to any part of the Derivative Works, in at least one+ of the following places: within a NOTICE text file distributed+ as part of the Derivative Works; within the Source form or+ documentation, if provided along with the Derivative Works; or,+ within a display generated by the Derivative Works, if and+ wherever such third-party notices normally appear. The contents+ of the NOTICE file are for informational purposes only and+ do not modify the License. You may add Your own attribution+ notices within Derivative Works that You distribute, alongside+ or as an addendum to the NOTICE text from the Work, provided+ that such additional attribution notices cannot be construed+ as modifying the License.++ You may add Your own copyright statement to Your modifications and+ may provide additional or different license terms and conditions+ for use, reproduction, or distribution of Your modifications, or+ for any such Derivative Works as a whole, provided Your use,+ reproduction, and distribution of the Work otherwise complies with+ the conditions stated in this License.++ 5. Submission of Contributions. Unless You explicitly state otherwise,+ any Contribution intentionally submitted for inclusion in the Work+ by You to the Licensor shall be under the terms and conditions of+ this License, without any additional terms or conditions.+ Notwithstanding the above, nothing herein shall supersede or modify+ the terms of any separate license agreement you may have executed+ with Licensor regarding such Contributions.++ 6. Trademarks. This License does not grant permission to use the trade+ names, trademarks, service marks, or product names of the Licensor,+ except as required for reasonable and customary use in describing the+ origin of the Work and reproducing the content of the NOTICE file.++ 7. Disclaimer of Warranty. Unless required by applicable law or+ agreed to in writing, Licensor provides the Work (and each+ Contributor provides its Contributions) on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+ implied, including, without limitation, any warranties or conditions+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+ PARTICULAR PURPOSE. You are solely responsible for determining the+ appropriateness of using or redistributing the Work and assume any+ risks associated with Your exercise of permissions under this License.++ 8. Limitation of Liability. In no event and under no legal theory,+ whether in tort (including negligence), contract, or otherwise,+ unless required by applicable law (such as deliberate and grossly+ negligent acts) or agreed to in writing, shall any Contributor be+ liable to You for damages, including any direct, indirect, special,+ incidental, or consequential damages of any character arising as a+ result of this License or out of the use or inability to use the+ Work (including but not limited to damages for loss of goodwill,+ work stoppage, computer failure or malfunction, or any and all+ other commercial damages or losses), even if such Contributor+ has been advised of the possibility of such damages.++ 9. Accepting Warranty or Additional Liability. While redistributing+ the Work or Derivative Works thereof, You may choose to offer,+ and charge a fee for, acceptance of support, warranty, indemnity,+ or other liability obligations and/or rights consistent with this+ License. However, in accepting such obligations, You may act only+ on Your own behalf and on Your sole responsibility, not on behalf+ of any other Contributor, and only if You agree to indemnify,+ defend, and hold each Contributor harmless for any liability+ incurred by, or claims asserted against, such Contributor by reason+ of your accepting any such warranty or additional liability.++ END OF TERMS AND CONDITIONS++ APPENDIX: How to apply the Apache License to your work.++ To apply the Apache License to your work, attach the following+ boilerplate notice, with the fields enclosed by brackets "[]"+ replaced with your own identifying information. (Don't include+ the brackets!) The text should be enclosed in the appropriate+ comment syntax for the file format. We also recommend that a+ file or class name and description of purpose be included on the+ same "printed page" as the copyright notice for easier+ identification within third-party archives.++ Copyright 2019 Domen Kožar++ Licensed under the Apache License, Version 2.0 (the "License");+ you may not use this file except in compliance with the License.+ You may obtain a copy of the License at++ http://www.apache.org/licenses/LICENSE-2.0++ Unless required by applicable law or agreed to in writing, software+ distributed under the License is distributed on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+ See the License for the specific language governing permissions and+ limitations under the License.
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ releaser.cabal view
@@ -0,0 +1,39 @@+cabal-version: 2.4+name: releaser+synopsis: Automation of Haskell package release process+version: 0.1.0.0+license: Apache-2.0+license-file: LICENSE+maintainer: domen@dev.si+author: Domen Kozar+category: Development+extra-source-files:+ CHANGELOG.md++source-repository head+ type: git+ location: https://github.com/domenkozar/releaser/++library+ exposed-modules:+ Releaser.Primitives+ hs-source-dirs: src+ default-language: Haskell2010+ build-depends:+ base -any,+ Cabal -any,+ regex-pcre -any,+ process -any,+ pretty-terminal -any++executable releaser+ main-is: Main.hs+ default-language: Haskell2010+ hs-source-dirs: releaser+ other-modules:+ Paths_releaser+ autogen-modules:+ Paths_releaser+ build-depends:+ base >=4.7 && <5,+ releaser -any
+ releaser/Main.hs view
@@ -0,0 +1,27 @@+module Main (main) where++import Releaser.Primitives+import System.IO (hSetBuffering, stdout, stderr, BufferMode(..))++main :: IO ()+main = do+ hSetBuffering stdout LineBuffering+ hSetBuffering stderr LineBuffering++ -- prepare release+ -- TODO: pass a list directories+ gitAssertEmptyStaging+ version <- cabalBumpVersion "."+ let release = "v" <> version+ gitCheckout release+ changelogPrepare++ -- make release+ tarball <- cabalSdist "."+ gitCommit $ "Bump to " <> release+ gitTag release++ -- syncing github/hackage+ gitPush "origin"+ gitPushTags "origin"+ cabalUpload tarball
+ src/Releaser/Primitives.hs view
@@ -0,0 +1,199 @@+module Releaser.Primitives (+ -- cabal utilities+ CabalInfo(..)+ , cabalRead+ , cabalWriteVersion+ , cabalBumpVersion+ , cabalSdist+ , cabalUpload+ -- git primitives+ , gitCheckout+ , gitGetTags+ , gitTag+ , gitCommit+ , gitPush+ , gitPushTags+ , gitAssertEmptyStaging+ -- utilities+ , prompt+ , abort+ , logStep+ , changelogPrepare+ ) where++import System.IO +import System.Process+import System.Console.Pretty (Color(..), color)+import System.Environment (lookupEnv)+import System.Exit (ExitCode(..), exitFailure)+import Text.Regex.PCRE+import Data.Functor (void)+import Data.List (intercalate)+import Text.ParserCombinators.ReadP (ReadP, readP_to_S)+import Data.Version (parseVersion)+import Distribution.PackageDescription.Parsec+import Distribution.Verbosity (silent)+import Distribution.Types.PackageId (pkgVersion, pkgName)+import Distribution.Types.PackageDescription (package)+import Distribution.Types.GenericPackageDescription (packageDescription)+import Distribution.PackageDescription.PrettyPrint (writeGenericPackageDescription)+import Distribution.Types.Version (versionNumbers, mkVersion')+import Distribution.Simple.Utils (tryFindPackageDesc)+import Distribution.Types.PackageName (unPackageName)++logStep :: String -> IO ()+logStep str = + putStrLn $ color Green ">> " <> str++prompt :: String -> IO String+prompt str = do+ putStr $ color Blue ">> " <> str+ hFlush stdout+ getLine ++abort :: String -> IO a+abort str = do+ putStrLnErr $ color Red ">> " <> str+ exitFailure++data CabalInfo = CabalInfo + { name :: String+ , version :: String+ }++-- | Given a folder, find a Cabal file and read the package version+cabalRead :: FilePath -> IO CabalInfo+cabalRead dir = do+ logStep $ "Looking for a cabal file in " <> dir+ cabalFile <- tryFindPackageDesc dir+ genericPackageDescription <- readGenericPackageDescription silent cabalFile+ let pkgversion = pkgVersion $ package $ packageDescription genericPackageDescription+ pkgname = pkgName $ package $ packageDescription genericPackageDescription+ cabalinfo = CabalInfo + { version = intercalate "." $ show <$> versionNumbers pkgversion+ , name = unPackageName pkgname+ }+ logStep $ "Found " <> name cabalinfo <> "-" <> version cabalinfo+ return cabalinfo++-- | Given a folder, find a Cabal file and update the package version+cabalWriteVersion :: FilePath -> String -> IO ()+cabalWriteVersion dir versionStr = do+ cabalFile <- tryFindPackageDesc dir+ genericPackageDescription <- readGenericPackageDescription silent cabalFile+ -- TODO: handle the read failure nicely+ version <- case parseMaybe parseVersion versionStr of+ Nothing -> abort "parsing the cabal version failed"+ Just ver -> return ver+ let+ pd = packageDescription genericPackageDescription+ p = package $ packageDescription genericPackageDescription+ gpd = genericPackageDescription { packageDescription = pd { package = p { pkgVersion = mkVersion' version } } }+ writeGenericPackageDescription cabalFile gpd+ logStep $ "Bumped " <> unPackageName (pkgName p) <> " to " <> versionStr+ where+ parseMaybe :: ReadP a -> String -> Maybe a+ parseMaybe parser input =+ case readP_to_S parser input of+ [] -> Nothing+ xs -> Just $ fst (last xs)++validCabalVersion :: String -> Bool+validCabalVersion version =+ version =~ "^[0-9]+([.][0-9]+)*$"++putStrLnErr :: String -> IO ()+putStrLnErr = hPutStrLn stderr++cabalBumpVersion :: FilePath -> IO String+cabalBumpVersion dir = do+ cabalinfo <- cabalRead dir+ version <- prompt $ "Bump cabal version from " <> version cabalinfo <> " to: "+ if validCabalVersion version+ then do + cabalWriteVersion dir version+ return version+ else do+ putStrLnErr "Cabal version does not match /^[0-9]+([.][0-9]+)*$/. Try again."+ cabalBumpVersion dir++cabalSdist :: FilePath -> IO FilePath+cabalSdist dir = do+ logStep "Running $ cabal dist"+ cabalinfo <- cabalRead dir+ void $ readProcess "cabal" ["sdist"] mempty+ let sdistTarball = "dist/" <> name cabalinfo <> "-" <> version cabalinfo <> ".tar.gz"+ logStep $ "Created " <> sdistTarball+ return sdistTarball++cabalUpload :: FilePath -> IO ()+cabalUpload sdistTarball = do+ logStep "Running $ cabal upload"+ -- TODO: recommend that credentials are configured via ~/cabal/config+ interactiveProcess (proc "cabal" ["upload", "--publish", sdistTarball]) (return ()) $ \_ -> do+ cabalUpload sdistTarball+ +gitGetTags :: IO [String]+gitGetTags = do+ lines <$> readProcess "git" ["tag"] mempty++-- TODO: what can we do if previous release process terminated and branch exists?+gitCheckout :: String -> IO ()+gitCheckout tag = do+ logStep $ "Running $ git checkout -b " <> tag+ -- TODO: check for existing branch+ void $ readProcess "git" ["checkout", "-b", tag] mempty++gitTag :: String -> IO ()+gitTag tag = do+ logStep $ "Running $ git tag --annotate --sign " <> tag+ tags <- gitGetTags+ if elem tag tags+ then abort "git tag already exists, please delete it and start over"+ else interactiveProcess (proc "git" ["tag", "--annotate", "--sign", tag]) (return ()) $ \i-> do + gitTag tag++gitCommit :: String -> IO ()+gitCommit message = do+ logStep $ "Running $ git commit "+ void $ readProcess "git" ["commit", "-a", "-m", message] mempty++gitPush :: String -> IO ()+gitPush remote = do+ logStep $ "Pushing git to " <> remote+ void $ readProcess "git" ["push", remote, "HEAD"] mempty++gitPushTags :: String -> IO ()+gitPushTags remote = do+ logStep $ "Pushing git to " <> remote+ void $ readProcess "git" ["push", remote, "--tags"] mempty++gitAssertEmptyStaging :: IO ()+gitAssertEmptyStaging = do+ logStep "Assserting there are no uncommitted files"+ output <- readProcess "git" ["status", "--untracked-files=no", "--porcelain"] mempty+ if output == ""+ then return ()+ else abort "git status is not clean"++changelogPrepare :: IO ()+changelogPrepare = do+ logStep "Assserting there are no uncommitted files"+ editorEnv <- lookupEnv "EDITOR"+ case editorEnv of+ Nothing -> abort "please make sure $EDITOR is set"+ Just editor -> do+ -- TODO: prepare the changelog+ interactiveProcess (proc editor ["CHANGELOG.md"]) (return ()) $ \i -> do+ logStep $ editor <> " failed with " <> show i <> ", retrying"+ changelogPrepare++-- internal++interactiveProcess :: CreateProcess -> IO b -> (Int -> IO b) -> IO b+interactiveProcess cmd good bad = do+ (_, _, _, ph) <- createProcess cmd+ exitcode <- waitForProcess ph+ case exitcode of+ ExitSuccess -> good+ ExitFailure i -> bad i