pipedawg 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6da632acfefa54ce858d4277758160be20246355596f84a5cf7f7a47c6bf7f93
-  data.tar.gz: 52c803810e345742b2ae1f0ff10e19e3afd5a8423164667346fcda75d78b54ee
+  metadata.gz: 9167728fbd620f0098099ff53a90fb1d85336a8a771b24cc3059b8dc03144285
+  data.tar.gz: 6f1d59f9fb1ca2de1a49d04520f6a9cd7f171f569c72a372899f9f28749ead34
 SHA512:
-  metadata.gz: 3aa2f038cabfca9659ac80cc1c04a186d3ffed3d5dac47e3ab64140f09d1c5dfecba9d41c59e90e7215dab99edad8aeff8a3f2162b11b88b42551fe88ace12e8
-  data.tar.gz: 758697c43505ff847d74e3c5db85417652636dda97082b444ef975752dd03cd0853d6cc78b9403c9ecf11894510daf5ded82edeab7bb7b1e99b9441ec28b207b
+  metadata.gz: f53e89a60305aaa04c14443c404e3bcfa0fa24274503751c927ff6ace5f9cabbeb87f3bc2e87ca81d04a9c14aa280ca2942b381eeecbbae23db4bfd4c4c2165e
+  data.tar.gz: a3f7acd6b467e21fee88fa2e2b22ef55e60030311355fb3074ae0f4eac0a52674c0027c0b4ebb0b21dfb1317ee5d1e3a753ece8f96c098183699c53d04a703ae

data/README.md

@@ -1,10 +1,18 @@
-# Pipedawg
+# pipedawg
+
+[![Gem Version](https://badge.fury.io/rb/pipedawg.svg)](https://rubygems.org/gems/pipedawg)
 
 Generate GitLab CI pipelines.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install `pipedawg` with:
+
+```
+gem install pipedawg
+```
+
+Or add this line to your application's Gemfile:
 
 ```ruby
 gem 'pipedawg'
@@ -12,25 +20,104 @@ gem 'pipedawg'
 
 And then execute:
 
-    $ bundle install
+```sh
+bundle install
+```
 
-Or install it yourself as:
+## Ruby library
 
-    $ gem install pipedawg
+Example:
 
-## Usage
+```ruby
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# print_pipeline.rb
+require 'pipedawg'
+
+gem_job = Pipedawg::Job.new(
+  'build:gem',
+  artifacts: ['*.gem'],
+  image: 'ruby',
+  script: ['bundle install', 'gem build *.gemspec']
+)
+
+docker_job = Pipedawg::Job.new(
+  'build:docker',
+  image: 'docker',
+  needs: ['build:gem'],
+  retry: 2,
+  script: [
+    'docker login -u gitlab-ci-token -p $CI_BUILD_TOKEN $CI_REGISTRY',
+    'docker pull $CI_REGISTRY_IMAGE || true',
+    'docker build --pull --cache-from $CI_REGISTRY_IMAGE -t $CI_REGISTRY_IMAGE .',
+    'docker push $CI_REGISTRY_IMAGE'
+  ],
+  services: ['docker:dind']
+)
+
+pipeline = Pipedawg::Pipeline.new 'build:image', jobs: [gem_job, docker_job]
+
+# Automatically calculates stages of jobs based on 'needs'
+pipeline.update_stages
+
+puts pipeline.to_yaml
+```
 
+```console
+$ chmod +x print_pipeline.rb
+$ ./print_pipeline.rb
+---
+stages:
+- '1'
+- '2'
+workflow: {}
+build:gem:
+  artifacts:
+  - "*.gem"
+  cache: {}
+  image: ruby
+  needs: []
+  rules: []
+  script:
+  - bundle install
+  - gem build *.gemspec
+  stage: '1'
+  tags: []
+build:docker:
+  artifacts: {}
+  cache: {}
+  image: docker
+  needs:
+  - build:gem
+  retry: 2
+  rules: []
+  script:
+  - docker login -u gitlab-ci-token -p $CI_BUILD_TOKEN $CI_REGISTRY
+  - docker pull $CI_REGISTRY_IMAGE || true
+  - docker build --pull --cache-from $CI_REGISTRY_IMAGE -t $CI_REGISTRY_IMAGE .
+  - docker push $CI_REGISTRY_IMAGE
+  stage: '2'
+  tags: []
+  services:
+  - docker:dind
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. Run `bundle exec rubocop` to run the linter. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+Note that by default, Bundler will attempt to install gems to the system, e.g. `/usr/bin`, `/usr/share`, which requires elevated access and can interfere with files that are managed by the system's package manager. This behaviour can be overridden by creating the file `.bundle/config` and adding the following line:
+```
+BUNDLE_PATH: "./.bundle"
+```
+When you run `bin/setup` or `bundle install`, all gems will be installed inside the .bundle directory of this project.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To make this behaviour a default for all gem projects, the above line can be added to the user's bundle config file in their home directory (`~/.bundle/config`)
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/liger1978/pipedawg.
-
+Bug reports and pull requests are welcome on [GitHub](https://github.com/liger1978/pipedawg).
 
 ## License
 

data/lib/pipedawg/pipeline.rb

@@ -24,7 +24,7 @@ module Pipedawg
       JSON.parse(pipeline.to_json).to_yaml
     end
 
-    def to_yaml_file(file = '.gitlab-ci.yml')
+    def to_yaml_file(file = 'pipeline.yml')
       File.write(file, to_yaml)
     end
 

data/lib/pipedawg/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pipedawg
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pipedawg
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - harbottle
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-18 00:00:00.000000000 Z
+date: 2022-01-28 00:00:00.000000000 Z
 dependencies: []
 description: Generate GitLab CI pipelines.
 email:
@@ -17,21 +17,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".bundle/config"
-- ".gitignore"
-- ".gitlab-ci.yml"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/pipedawg.rb
 - lib/pipedawg/job.rb
 - lib/pipedawg/pipeline.rb
 - lib/pipedawg/version.rb
-- pipedawg.gemspec
 homepage: https://github.com/liger1978/pipedawg
 licenses:
 - MIT

data/.bundle/config

@@ -1,4 +0,0 @@
----
-BUNDLE_BIN: "bin"
-BUNDLE_DISABLE_SHARED_GEMS: "true"
-BUNDLE_PATH: "./bundle"

data/.gitignore

@@ -1,15 +0,0 @@
-/bin/
-/bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/*.gem
-/vendor
-Gemfile.lock
-
-# rspec failure tracking
-.rspec_status

data/.gitlab-ci.yml

@@ -1,14 +0,0 @@
----
-stages:
-- build
-workflow: {}
-build:
-  artifacts: {}
-  cache: {}
-  image:
-    name: ruby:2.5
-  needs: []
-  rules: []
-  script: []
-  stage: build
-  tags: []

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,14 +0,0 @@
----
-AllCops:
-  Exclude:
-    - 'bin/**/*'
-    - 'bundle/**/*'
-    - '*.gemspec'
-  NewCops: enable
-
-Metrics/BlockLength:
-  Exclude:
-    - 'Rakefile'
-    - '**/*.rake'
-    - 'test/**/*.rb'
-    - 'spec/**/*_spec.rb'

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.6
-before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in pipedawg.gemspec
-gemspec
-
-gem 'irb', '~> 1.4'
-gem 'rake', '~> 12.0'
-gem 'rdoc', '~> 6.4'
-gem 'rspec', '~> 3.0'
-gem 'rubocop', '~> 1.24', require: false
-gem 'rubocop-rake', '~> 0.6', require: false
-gem 'rubocop-rspec', '~> 2.7', require: false

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/pipedawg.gemspec

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/pipedawg/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'pipedawg'
-  spec.version       = Pipedawg::VERSION
-  spec.authors       = ['harbottle']
-  spec.email         = ['harbottle@room3d3.com']
-
-  spec.summary       = 'Generate GitLab CI pipelines.'
-  spec.description   = 'Generate GitLab CI pipelines.'
-  spec.homepage      = 'https://github.com/liger1978/pipedawg'
-  spec.license       = 'MIT'
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/liger1978/pipedawg'
-  spec.metadata['changelog_uri'] = 'https://github.com/liger1978/pipedawg'
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-end