samus 3.0.4 → 3.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5abc0a8419bc2037a0f18d7473a0156909deb7e0de4d900256b5829592db883
-  data.tar.gz: 39895dfb2f089a65ff1e03cc6412011b62254d4a469ca210822a0b8adc5fccf9
+  metadata.gz: f04e142129687658a7fd111af0ed1587d9e6d6c2b5d7d5c8b6eaab195940dfa9
+  data.tar.gz: a53a88046167502a858b185831d20217a4542c19a6305b618f9467093231bed6
 SHA512:
-  metadata.gz: b25b940e53902fa2d3a73f040ec78dcdd94d9d4070e831b77f8ce14c0b7cff9b14e5cfa534739abda9e4ee0158eb9dbafb03f543d8bd6125153e4c343a80882a
-  data.tar.gz: aee76adacf89dd1d58741bb16220cc53ce7d83eeb9330151e3e1fd9dced2aa462f03912e86ddd0f6931b8f6fc27dcb6748934a5587bbf800fe9af61345abdd4d
+  metadata.gz: 8613ffe3e5f6106b92c15a527854f1b0e21f0f6c0aba4358a5e77214a169768e75ba7c7be8f80b501a06e28eb7ba29cc822f63ffe89aec378e48982b16af2f70
+  data.tar.gz: b2dbfc18ff675b399cc4e781a62ab461e32669f08a2fb1924a742aa1a7c1289c4d48f82ee1eaefe05d6cfeeffed88ccc4de9e2cc18fd888c02108bfe18e3f7cb

data/CHANGELOG.md

@@ -1,3 +1,38 @@
+# main
+
+# 3.0.9 - June 19th, 2020
+
+[3.0.9]: https://github.com/lsegal/samus/compare/v3.0.8...v3.0.9
+
+- Improved support for alternate primary branch names
+
+# 3.0.8 - April 1st, 2019
+
+[3.0.8]: https://github.com/lsegal/samus/compare/v3.0.7...v3.0.8
+
+- Fix timezone handling issue.
+
+# 3.0.7 - April 1st, 2019
+
+[3.0.7]: https://github.com/lsegal/samus/compare/v3.0.6...v3.0.7
+
+- Fix bug in `publish` task of DockerReleaseTask in previous release.
+
+# 3.0.6 - April 1st, 2019
+
+[3.0.6]: https://github.com/lsegal/samus/compare/v3.0.5...v3.0.6
+
+- Add `--skip-restore` to samus build to skip restoring Git repository. Useful
+  with Docker build support in order to inspect output of a built release.
+- Add `build/changelog-rotate` command for changelog rotation.
+- Add `inspect` and `clean` Rake tasks for `DockerReleaseTask` to inspect and
+  remove a previously built release respectively.
+
+# 3.0.5 - April 1st, 2019
+
+- Fix bug that breaks DockerReleaseTask if .gitconfig or .samus configs are
+  not present on the system.
+
 # 3.0.4 - April 1st, 2019
 
 - Automatically build Dockerfile.samus as tempfile if it is not present in
@@ -92,7 +127,3 @@ end
 # 1.3.0 - July 23, 2014
 
 - Fix issue where repository would not reset when using `samus-build` command.
-
-```
-
-```

data/Dockerfile

@@ -2,8 +2,8 @@ FROM python:3.7-alpine
 
 RUN apk add -U --no-cache openssh ruby ruby-json nodejs git curl
 RUN pip install awscli
-RUN gem install bundler -v '1.17.3' --no-rdoc --no-ri
-RUN gem install rake --no-rdoc --no-ri
+RUN gem install bundler --no-document
+RUN gem install rake --no-document
 RUN mkdir -p ~/.ssh
 RUN echo "Host *" > ~/.ssh/config
 RUN echo "    StrictHostKeyChecking no" >> ~/.ssh/config
@@ -13,6 +13,7 @@ RUN git config --global user.email "bot@not.human"
 RUN git config --global user.name "Samus Release Bot"
 
 COPY . /samus
+RUN chmod 755 /samus/commands/build/* /samus/commands/publish/*
 ENV PATH=$PATH:/samus/bin
 
 WORKDIR /build

data/README.md

@@ -18,7 +18,7 @@ machine.
 Samus is a RubyGem and requires Ruby 1.9.x+. Installing is as easy as typing:
 
 ```sh
-$ gem install samus
+gem install samus
 ```
 
 If you would rather use Samus via Docker, see the Docker section in Usage below.
@@ -44,7 +44,7 @@ manifest file is just a list of discrete actions like so (minus comments):
       "action": "git-push",
       "arguments": {
         "remotes": "origin",
-        "refs": "master v1.5.0" // the v1.5.0 is a tag for your release
+        "refs": "main v1.5.0" // the v1.5.0 is a tag for your release
       }
     },
     {
@@ -91,9 +91,9 @@ it "samus.json" for easier integration:
       "files": ["lib/my-gem/version.rb"]
     },
     {
-      "action": "git-merge", // merge new commit into master branch
+      "action": "git-merge", // merge new commit into main branch
       "arguments": {
-        "branch": "master"
+        "branch": "main"
       }
     },
     {
@@ -103,7 +103,7 @@ it "samus.json" for easier integration:
         "action": "git-push",
         "arguments": {
           "remotes": "origin",
-          "refs": "master v$version"
+          "refs": "main v$version"
         }
       }]
     },
@@ -123,12 +123,12 @@ it "samus.json" for easier integration:
 ```
 
 It looks a little longer, but it contains all of the steps to automate when
-bumping the VERSION constant, tagging a version, merging into the master
+bumping the VERSION constant, tagging a version, merging into the primary
 branch, and building the gem. To build a release with this manifest, simply
 type:
 
 ```sh
-$ samus build 1.5.0
+samus build 1.5.0
 ```
 
 Samus will look for `samus.json` and build a release for version 1.5.0 of your
@@ -136,10 +136,10 @@ code. It will produce an archive called `release-v1.5.0.tar.gz` that you
 can then publish with:
 
 ```sh
-$ samus publish release-v1.5.0.tar.gz
+samus publish release-v1.5.0.tar.gz
 ```
 
-You may have noticed some funny looking "$version" strings in the above
+You may have noticed some funny looking "\$version" strings in the above
 manifest. Those strings will be replaced with the version provided in the
 build command, so all the correct tagging and building will be handled for you.
 
@@ -227,14 +227,14 @@ repositories. In this case, you can simply type `samus install REPO` to
 download the repository to your machine:
 
 ```sh
-$ samus install git@github.com:my_org/samus_config
+samus install git@github.com:my_org/samus_config
 ```
 
 Of course, Samus doesn't need these custom packages to be Git-backed. All
 the above command does is clone a repository into the ~/.samus directory.
 The above command creates:
 
-```
+```plaintext
 .samus/
   `- samus_config/
      `- commands/
@@ -274,18 +274,20 @@ commands directory depending on whether they are for `samus build` or
 In addition to exposing arguments as underscored environment variables,
 Samus also exposes a few special variables with double underscore prefixes:
 
-- `__build_dir` - this variable refers to the temporary directory that the
+- `__BUILD_DIR` - this variable refers to the temporary directory that the
   release package is being built inside of. The files inside of this directory,
   and _only_ the files inside of this directory, will be built into the release
   archive. If you write a build-time command that produces an output file which
   is part of the release, you should make sure to move it into this directory.
-- `__restore_file` - the restore file is a newline delimited file containing
+- `__ORIG_BRANCH` - the original branch being built from.
+- `__BUILD_BRANCH` - the name of the branch being built to.
+- `__RESTORE_FILE` - the restore file is a newline delimited file containing
   branches and their original ref. All branches listed in this file will be
   restored to the respective ref at the end of `samus build` regardless of
   success status. If you make destructive modifications to existing branches
   in the workspace repository, you should add the original ref for the branch
   to this file.
-- `__creds_*` - provides key, secret, and other values loaded from credentials.
+- `__CREDS_*` - provides key, secret, and other values loaded from credentials.
   See Credentials section for more information on how these are set.
 
 #### Help Files
@@ -295,14 +297,15 @@ command should include a file named `your-command.help.md` in the same directory
 as the command script itself. These files are Markdown-formatted files and
 should follow the same structure of the built-in command help files:
 
-```
+```markdown
 Short description of command.
 
-* Files:
-  * Description of what the command line arguments are
+- Files:
+
+  - Description of what the command line arguments are
 
-* Arguments:
-  * argname: Documentation for argument
+- Arguments:
+  - argname: Documentation for argument
 ```
 
 Notes:
@@ -425,7 +428,7 @@ property:
 
 The "condition" property is a Ruby expression that is evaluated for truthiness
 to decide if the action item should be evaluated or skipped. A common use for
-this is to take action based on the version (see "$version" variable section
+this is to take action based on the version (see "\$version" variable section
 below). The following example runs an action item only for version 2.0+ of a
 release:
 
@@ -437,9 +440,9 @@ release:
 }
 ```
 
-#### "$version" Variable
+#### "\$version" Variable
 
-A special variable "$version" is interpolated when loading the build manifest.
+A special variable "\$version" is interpolated when loading the build manifest.
 This variable can appear anywhere in the JSON document, and is interpolated
 before any actions or conditions are evaluated.
 

data/bin/samus

@@ -43,6 +43,7 @@ command =
 
 dry_run = false
 zip_release = true
+skip_restore = false
 outfile = nil
 docker = false
 docker_image = "lsegal/samus:latest"
@@ -63,6 +64,9 @@ options = OptionParser.new do |opts|
     opts.on('-o FILE', '--output', 'The file (no extension) to generate') do |file|
       outfile = file
     end
+    opts.on('--skip-restore', 'Skips restore after build completes') do
+      skip_restore = true
+    end
   end
   opts.on('--docker', 'Use Docker to build or publish') do |_v|
     docker = true
@@ -107,7 +111,7 @@ elsif command == Samus::Builder
   Samus::Builder.build_version = ver.sub(/^v/, '')
 
   (ARGV.empty? ? ['samus.json'] : ARGV).each do |file|
-    command.new(file).build(dry_run, zip_release, outfile)
+    command.new(file).build(dry_run, zip_release, outfile, skip_restore)
   end
 else
   puts options

data/commands/build/changelog-rotate

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+file = ARGV[0]
+ver = ENV['_VERSION']
+heading = ENV['_HEADING'] || ENV['_MASTER'] || ENV['__ORIG_BRANCH']
+title_fmt = ENV['_TITLE_FORMAT'] || "[$version] - %B %-d$day_nth, %Y"
+ENV['TZ'] ||= ENV['_TZ']
+
+content = File.read(file)
+compare_url = `git config remote.origin.url`.strip.sub(/^git@(.+?):/, 'https://\1/')
+day_nth = {1 => 'st', 2 => 'nd', 3 => 'rd'}[Time.now.day % 10] || 'th'
+title = Time.now.strftime(title_fmt).sub('$version', ver).sub('$day_nth', day_nth)
+
+match = /\A\s*# #{heading}\r?\n(?<body>.*?)(?<rest>\r?\n# .+|\Z)/mis.match(content)
+raise "Failed to rotate changelog: #{file} (invalid heading: #{heading})" unless match
+
+prev_ver = match['rest'][/(\d+\.\d+(?:\.\d+)?)/, 1]
+repl = "# #{heading}\n\n# #{title}\n\n" +
+  (prev_ver ? "[#{ver}]: #{compare_url}/compare/v#{prev_ver}...v#{ver}\n" : '') +
+  match['body'] + match['rest']
+File.open(file, 'w') {|f| f.write(repl) }
+puts "Added new #{file} header: #{title}"
+puts "Previous #{file} version: #{prev_ver.inspect}"

data/commands/build/changelog-rotate.help.md

@@ -0,0 +1,18 @@
+Rotates the latest ChangeLog entries into an arbitrary formatted title heading.
+The heading is formatted via `title_format` and can include the version
+and release date.
+
+Files:
+
+- The path to the ChangeLog file.
+
+Arguments:
+
+- heading: (optional) defaults to primary branch name, should match the first development
+  heading used for in-flux changelog entries before rotation.
+- title_format: (optional) a `Time.strftime` date formatted string that can
+  also include `$version` to represent the title of the rotated changelog entry.
+  Example: `$version - %B %-d, %Y`. It is recommended to put the version at the
+  front of the title to improve the reliability of generating a compare URL.
+- tz: (optional) set the timezone if not available on the build system. Defaults
+  to system timezone.

data/commands/build/git-clone

@@ -1,8 +1,20 @@
 #!/bin/sh
 
 set -e
-git clone -q --branch ${_BRANCH-master} \
+
+cd ${_REPOSITORY-.}
+BRANCHES=`git branch --list --format="%(refname:lstrip=2)"`
+
+git clone -q $([ -n "$_BRANCH" ] && echo --branch $_BRANCH) \
   ${_REPOSITORY-.} $__BUILD_DIR/$1 2>${__DEVNULL-/dev/null}
 
+oldpw=`pwd`
+cd $__BUILD_DIR/$1
+for branch in $BRANCHES; do
+  echo Copying over $branch from repository.
+  git branch $branch --track origin/$branch 2>${__DEVNULL-/dev/null} || true
+done
+cd $oldpw
+
 # preserve all previously configured remotes for publish actions
 cp ${_REPOSITORY-.}/.git/config $__BUILD_DIR/$1/.git/config

data/commands/build/git-clone.help.md

@@ -5,4 +5,4 @@ Files:
 
 Arguments:
   * repository: the location of the working copy repository, defaults to ".".
-  * branch:     the branch to clone, defaults to "master"
+  * branch:     the branch to clone, clones to default primary if not provided.

data/lib/samus.rb

@@ -6,8 +6,8 @@ module Samus
 
   module Rake
     # Autoloads
-    autoload :ReleaseTask, File.expand_path('samus/rake/samus_task', __dir__)
-    autoload :DockerReleaseTask, File.expand_path('samus/rake/samus_task', __dir__)
+    autoload :ReleaseTask, File.expand_path('samus/rake/tasks', __dir__)
+    autoload :DockerReleaseTask, File.expand_path('samus/rake/tasks', __dir__)
   end
 
   module_function

data/lib/samus/builder.rb

@@ -22,7 +22,7 @@ module Samus
       @manifest = {}
     end
 
-    def build(dry_run = false, zip_release = true, outfile = nil)
+    def build(dry_run = false, zip_release = true, outfile = nil, skip_restore = false)
       orig_pwd = Dir.pwd
       manifest = { 'version' => version, 'actions' => [] }
       build_branch = "samus-release/v#{version}"
@@ -43,6 +43,7 @@ module Samus
                             '_RESTORE_FILE' => RESTORE_FILE,
                             '_BUILD_DIR' => build_dir,
                             '_BUILD_BRANCH' => build_branch,
+                            '_ORIG_BRANCH' => orig_branch,
                             '_DEVNULL' => devnull,
                             'VERSION' => version
                           }).load(action)
@@ -60,9 +61,13 @@ module Samus
         end
       end
     ensure
-      restore_git_repo
-      system "git checkout -q #{orig_branch} 2>#{devnull}"
-      system "git branch -qD #{build_branch} 2>#{devnull}"
+      if skip_restore
+        remove_restore_file
+      else
+        restore_git_repo
+        system "git checkout -q #{orig_branch} 2>#{devnull}"
+        system "git branch -qD #{build_branch} 2>#{devnull}"
+      end
     end
 
     private

data/lib/samus/rake/{samus_task.rb → tasks.rb}

@@ -49,16 +49,20 @@ module Samus
 
         yield self if block_given?
 
+        build_config_files
+        define
+      end
+
+      private
+
+      def build_config_files
         @config_files = {
           Samus::CONFIG_PATH => '.samus',
           File.expand_path('~/.gitconfig') => '.gitconfig'
         }.merge(extra_config)
-
-        define
+        @config_files.select! {|src, _dst| File.exist?(src) }
       end
 
-      private
-
       def copy_prep
         FileUtils.rm_rf(PREP_DIR)
         FileUtils.mkdir_p(PREP_DIR)
@@ -79,12 +83,12 @@ module Samus
             "COPY . /build",
             config_copies.join("\n"),
             "RUN rm -rf /build/.samusprep",
-            "RUN samus build ${VERSION}"
+            "RUN samus build --skip-restore ${VERSION}"
           ].join("\n"))
         end
         fname
       end
-      
+
       def define
         namespace(@namespace) do
           desc '[VERSION=X.Y.Z] Builds a Samus release using Docker'
@@ -95,7 +99,7 @@ module Samus
 
             begin
               copy_prep
-              sh "docker build . -t #{img} -f #{build_or_get_dockerfile} --build-arg VERSION=#{ver}"
+              sh "docker build . --rm -t #{img} -f #{build_or_get_dockerfile} --build-arg VERSION=#{ver}"
             ensure
               FileUtils.rm_rf(PREP_DIR)
             end
@@ -105,10 +109,20 @@ module Samus
           task :publish do
             img = release_image
             mount = mount_samus_config ? "-v #{Samus::CONFIG_PATH}:/root/.samus:ro" : ''
-            sh "docker run #{mount} --rm #{img}"
-            sh "docker rmi -f #{img}" if delete_image_after_publish
+            sh "docker run #{mount} --rm #{release_image}"
+            ::Rake::Task["#{@namespace}:clean"].execute if delete_image_after_publish
             sh "git pull" if git_pull_after_publish
           end
+
+          desc '[VERSION=X.Y.Z] Inspects a built release using Docker shell'
+          task :inspect do
+            sh "docker run -it --entrypoint sh #{release_image}"
+          end
+
+          desc '[VERSION=X.Y.Z] Removes a built release using Docker'
+          task :clean do
+            sh "docker rmi -f #{release_image}"
+          end
         end
       end
     end
@@ -136,7 +150,7 @@ module Samus
       def zipfile
         @zipfile || "release-v#{release_version}.tar.gz"
       end
-      
+
       def define
         namespace(@namespace) do
           desc '[VERSION=X.Y.Z] Builds a Samus release'

data/lib/samus/version.rb

@@ -1,3 +1,3 @@
 module Samus
-  VERSION = '3.0.4'.freeze
+  VERSION = '3.0.9'.freeze
 end

data/samus.json

@@ -2,12 +2,24 @@
   "actions": [
     {
       "action": "fs-sedfiles",
-      "files": ["lib/*/version.rb"],
+      "files": [
+        "lib/*/version.rb"
+      ],
       "arguments": {
         "search": "VERSION = ['\"](.+?)['\"]",
         "replace": "VERSION = '$version'"
       }
     },
+    {
+      "action": "changelog-rotate",
+      "files": [
+        "CHANGELOG.md"
+      ],
+      "arguments": {
+        "title_format": "$version - %B %-d$day_nth, %Y",
+        "tz": "GMT+8"
+      }
+    },
     {
       "action": "chmod-files",
       "files": [
@@ -19,42 +31,53 @@
     },
     {
       "action": "git-commit",
-      "files": ["lib/*/version.rb"]
+      "files": [
+        "CHANGELOG.md",
+        "lib/*/version.rb"
+      ]
     },
     {
       "action": "git-merge",
       "arguments": {
-        "branch": "master"
+        "branch": "main"
       }
     },
     {
       "action": "git-clone",
-      "files": ["git-repo"],
+      "files": [
+        "git-repo"
+      ],
       "publish": [
         {
           "action": "git-push",
           "credentials": "lsegal.github.ssh",
           "arguments": {
             "remotes": "origin",
-            "refs": "master v$version"
+            "refs": "main v$version"
           }
         }
       ]
     },
     {
       "action": "gem-build",
-      "files": ["*.gemspec"],
+      "files": [
+        "*.gemspec"
+      ],
       "publish": [
         {
           "action": "gem-push",
-          "files": ["*.gem"],
+          "files": [
+            "*.gem"
+          ],
           "credentials": "lsegal.rubygems"
         }
       ]
     },
     {
       "action": "changelog-parse",
-      "files": ["CHANGELOG.md"],
+      "files": [
+        "CHANGELOG.md"
+      ],
       "publish": [
         {
           "action": "github-release",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: samus
 version: !ruby/object:Gem::Version
-  version: 3.0.4
+  version: 3.0.9
 platform: ruby
 authors:
 - Loren Segal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-01 00:00:00.000000000 Z
+date: 2020-06-20 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: lsegal@soen.ca
@@ -32,6 +32,8 @@ files:
 - commands/build/archive-zip.help.md
 - commands/build/changelog-parse
 - commands/build/changelog-parse.help.md
+- commands/build/changelog-rotate
+- commands/build/changelog-rotate.help.md
 - commands/build/chmod-files
 - commands/build/chmod-files.help.md
 - commands/build/fs-copy
@@ -90,7 +92,7 @@ files:
 - lib/samus/credentials.rb
 - lib/samus/publish_action.rb
 - lib/samus/publisher.rb
-- lib/samus/rake/samus_task.rb
+- lib/samus/rake/tasks.rb
 - lib/samus/version.rb
 - samus.gemspec
 - samus.json
@@ -113,8 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Samus helps you release Open Source Software.