bump-cli 0.1.0 → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (8) hide show
  1. checksums.yaml +4 -4
  2. data/.circleci/config.yml +7 -2
  3. data/CODE_OF_CONDUCT.md +1 -1
  4. data/LICENSE.txt +1 -1
  5. data/README.md +22 -4
  6. data/bump-cli.gemspec +2 -0
  7. data/lib/bump/cli/version.rb +1 -1
  8. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 45535ed74c676934e7c59f1c93ea05f7d278ee1079cc3dc7764ddda9f5f6e9bd
4
- data.tar.gz: 2568282f956a77d36498075e98be4017fdf990b3c3c50bc8636a99727ca7f17d
3
+ metadata.gz: 547fdfc416eb3c6e2f0e61ccd677f1bdd79ccd8aa761aee2723d397985df657c
4
+ data.tar.gz: 5b3e598e4469546da9c16275138e97bdcd750801022d49c792dbd70c9d2c7773
5
5
  SHA512:
6
- metadata.gz: b4d03f0d849414f60796bf4bbe48bfc2a0658b83a461cc5438c7410322866e43801b95300e1aa59f1f8c08b2649b908c7452cbd7a1c06ba23a7335279f9cf2e8
7
- data.tar.gz: 6f8c00a0de00234df798f87482706d0f4d1941f6179f7ef70591a604f5ec00067cb3962b4e61336cdcf78c90d0cb6af918075dc2ec2d5e8dfa9c6099cf8a3aea
6
+ metadata.gz: 4036fc2b31fbadc3019f055cf0b4bbaa46b9ee935cc42335287be9a63df8f72c7ebaecd681956f80ec2075b433bf94af1e0c434db6d641cf41df7fd27c357227
7
+ data.tar.gz: 83e5a034d7b4f8a983c44f262a39e206256a29b2c3d98a0fef49cf72b7c4baf3f0c7b4baf7022944ceaa0314d0ac92f694032372be7922ec7b30f5f28cdf855d
data/.circleci/config.yml CHANGED
@@ -3,7 +3,7 @@ jobs:
3
3
  build-latest: &common-build
4
4
  working_directory: ~/bump-cli
5
5
  docker:
6
- - image: circleci/ruby:latest
6
+ - image: circleci/ruby:2.5.0-node
7
7
  steps:
8
8
  - checkout
9
9
  - run:
@@ -30,14 +30,19 @@ jobs:
30
30
  - run:
31
31
  name: Run tests
32
32
  command: rake
33
+ build-2-4:
34
+ <<: *common-build
35
+ docker:
36
+ - image: circleci/ruby:2.4.3-node
33
37
  build-2-3:
34
38
  <<: *common-build
35
39
  docker:
36
- - image: circleci/ruby:2.3.4-node
40
+ - image: circleci/ruby:2.3.6-node
37
41
 
38
42
  workflows:
39
43
  version: 2
40
44
  build:
41
45
  jobs:
42
46
  - build-latest
47
+ - build-2-4
43
48
  - build-2-3
data/CODE_OF_CONDUCT.md CHANGED
@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
55
55
  ## Enforcement
56
56
 
57
57
  Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
- reported by contacting the project team at mehdi@lahmam.com. All
58
+ reported by contacting the project team at hello@bump.sh. All
59
59
  complaints will be reviewed and investigated and will result in a response that
60
60
  is deemed necessary and appropriate to the circumstances. The project team is
61
61
  obligated to maintain confidentiality with regard to the reporter of an incident.
data/LICENSE.txt CHANGED
@@ -1,6 +1,6 @@
1
1
  The MIT License (MIT)
2
2
 
3
- Copyright (c) 2017 Mehdi Lahmam
3
+ Copyright (c) 2018 It ducks
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
data/README.md CHANGED
@@ -1,8 +1,6 @@
1
1
  # Bump::CLI
2
2
 
3
- Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bump/cli`. To experiment with that code, run `bin/console` for an interactive prompt.
4
-
5
- TODO: Delete this and the text above, and describe your gem
3
+ The `bump-cli` gem provides a simple command line access to the Bump (https://bump.sh) API.
6
4
 
7
5
  ## Installation
8
6
 
@@ -22,7 +20,27 @@ Or install it yourself as:
22
20
 
23
21
  ## Usage
24
22
 
25
- TODO: Write usage instructions here
23
+ By default, `bump-cli` considers files as `yaml` ones. If you work with JSON definitions, you need to specify the format for all the commands using `--format json`.
24
+
25
+ The doc `id` and `token` used below can be found in your documentation settings page on https://bump.sh. Note that you can replace the options by environments variables: `--id` can be replaced by `BUMP_ID`, and `--token` can by replaced by `BUMP_TOKEN`. This is useful to keep your private token secret.
26
+
27
+ ### Preview
28
+
29
+ You can preview your documentation by calling the `preview` command. A temporary preview will be created, with a unique URL. This preview will be available for 30 minutes. You don't need any credentials to use this command.
30
+
31
+ $ bundle exec bump preview path/to/your/openapi.yml
32
+
33
+ ### Validate
34
+
35
+ Validate your file against the OpenApi specification.
36
+
37
+ $ bundle exec bump validate path/to/your/openapi.yml --id DOC_ID --token DOC_TOKEN
38
+
39
+ ### Deploy
40
+
41
+ Deploy the file as the current version of the documentation.
42
+
43
+ $ bundle exec bump deploy path/to/your/openapi.yml --id DOC_ID --token DOC_TOKEN
26
44
 
27
45
  ## Development
28
46
 
data/bump-cli.gemspec CHANGED
@@ -24,6 +24,8 @@ Gem::Specification.new do |spec|
24
24
  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
25
25
  spec.require_paths = ["lib"]
26
26
 
27
+ spec.required_ruby_version = '>= 2.3'
28
+
27
29
  spec.add_dependency "hanami-cli", '~> 0'
28
30
  spec.add_dependency "http", '~> 3'
29
31
 
data/lib/bump/cli/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  module Bump
2
2
  class CLI
3
- VERSION = "0.1.0"
3
+ VERSION = "0.1.1"
4
4
  end
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: bump-cli
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Mehdi Lahmam
@@ -150,7 +150,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
150
150
  requirements:
151
151
  - - ">="
152
152
  - !ruby/object:Gem::Version
153
- version: '0'
153
+ version: '2.3'
154
154
  required_rubygems_version: !ruby/object:Gem::Requirement
155
155
  requirements:
156
156
  - - ">="