samus 3.0.8 → 3.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47279c933b0dab9bdb56c9ef345f2d9330169b479a79b03c098d13c1164d5a28
-  data.tar.gz: 1edb84d24b1f00f5383d67e46a58f8c7fd39e72ff82358ba192b19a340343427
+  metadata.gz: f04e142129687658a7fd111af0ed1587d9e6d6c2b5d7d5c8b6eaab195940dfa9
+  data.tar.gz: a53a88046167502a858b185831d20217a4542c19a6305b618f9467093231bed6
 SHA512:
-  metadata.gz: 6f135fdb15cf918f35ac84f9dfdb4535a2c60dfdae2512f83b820fbfb61dd259b2033507259e14615371f1081a4ae46fbf542a244688baa51acc17832f2a60ec
-  data.tar.gz: 1accade2c2eb7adadb4599663d1a28f96db8e29c7af61e16f18df43e5e1c0e106ad10aa97207b2431469990a3af882988ec1184fd41d8e49ebbfde93659ed8e0
+  metadata.gz: 8613ffe3e5f6106b92c15a527854f1b0e21f0f6c0aba4358a5e77214a169768e75ba7c7be8f80b501a06e28eb7ba29cc822f63ffe89aec378e48982b16af2f70
+  data.tar.gz: b2dbfc18ff675b399cc4e781a62ab461e32669f08a2fb1924a742aa1a7c1289c4d48f82ee1eaefe05d6cfeeffed88ccc4de9e2cc18fd888c02108bfe18e3f7cb

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-# master
+# 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
 

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/commands/build/changelog-rotate

@@ -2,7 +2,7 @@
 
 file = ARGV[0]
 ver = ENV['_VERSION']
-master = ENV['_MASTER'] || 'master'
+heading = ENV['_HEADING'] || ENV['_MASTER'] || ENV['__ORIG_BRANCH']
 title_fmt = ENV['_TITLE_FORMAT'] || "[$version] - %B %-d$day_nth, %Y"
 ENV['TZ'] ||= ENV['_TZ']
 
@@ -11,11 +11,11 @@ compare_url = `git config remote.origin.url`.strip.sub(/^git@(.+?):/, 'https://\
 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*# #{master}\r?\n(?<body>.*?)(?<rest>\r?\n# .+|\Z)/mis.match(content)
-raise "Failed to rotate changelog: #{file}" unless match
+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 = "# #{master}\n\n# #{title}\n\n" +
+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) }

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

@@ -8,7 +8,7 @@ Files:
 
 Arguments:
 
-- master: (optional) defaults to "master", should match the first development
+- 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.

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/builder.rb

@@ -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)

data/lib/samus/version.rb

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

data/samus.json

@@ -2,7 +2,9 @@
   "actions": [
     {
       "action": "fs-sedfiles",
-      "files": ["lib/*/version.rb"],
+      "files": [
+        "lib/*/version.rb"
+      ],
       "arguments": {
         "search": "VERSION = ['\"](.+?)['\"]",
         "replace": "VERSION = '$version'"
@@ -10,7 +12,9 @@
     },
     {
       "action": "changelog-rotate",
-      "files": ["CHANGELOG.md"],
+      "files": [
+        "CHANGELOG.md"
+      ],
       "arguments": {
         "title_format": "$version - %B %-d$day_nth, %Y",
         "tz": "GMT+8"
@@ -27,42 +31,53 @@
     },
     {
       "action": "git-commit",
-      "files": ["CHANGELOG.md", "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.8
+  version: 3.0.9
 platform: ruby
 authors:
 - Loren Segal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-02 00:00:00.000000000 Z
+date: 2020-06-20 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: lsegal@soen.ca
@@ -115,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.