kickster 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4a291abb9c60b75c3ab2a79addc3ac21157021b
-  data.tar.gz: d4652f5720d4bb4f8769b3a5294c2769c8c7f669
+  metadata.gz: 1ccb57b7462de3a18ee009c3ba81a898e2983d19
+  data.tar.gz: f4441e9b06e9efdf6e6048fcb8349fd9b384e864
 SHA512:
-  metadata.gz: 9bd262140f02a9de7234d2e80de70ebc29a7d961cea1c169bc14f0b0528e5e188e6092de4156dda0b5d0d472e320d700d3ed6e395a42f9637e21f5b67cd3729b
-  data.tar.gz: b687b0edc27a5e1ff095a7ee2758575664f7a5fdb005ec19dd6f091999214baf8539a238b8317135f9ab58664e1206a28f2dee86752c3d60407d1204d5e62e48
+  metadata.gz: c83d729620c1bc06965859b52672c44616acc6f5595149e1e3c32fb8481eaea460753a70a4b42d85d9e1200775883473e23c85c66fbde78bb510e311e531b184
+  data.tar.gz: b72c3e632c000cd29dd0c000e78bd088f65cc52b8417b1a989bd0c3ce907a6099e4166f4b70126ef4136531a04ecbd54fbc4147e2e269498978678cf916b666a

data/README.md

@@ -5,6 +5,17 @@ Kickster
 
 Kickster provides a basic Jekyll project setup packed with web best practises and useful optimization tools increasing your overall project quality. Kickster ships with automated and worry-free deployment scripts for GitHub Pages.
 
+Used tools:
+
+  - [Autoprefixer](https://github.com/postcss/autoprefixer)
+  - [Bower](http://bower.io/)
+  - [Circle CI](https://circleci.com/)
+  - [Html-proofer](https://github.com/gjtorikian/html-proofer)
+  - [Jekyll](http://jekyllrb.com/)
+  - [Jekyll assets](https://github.com/jekyll/jekyll-assets)
+  - [Jekyll Sitemap](https://github.com/jekyll/jekyll-sitemap)
+  - [HTML5 Boilerplate](https://html5boilerplate.com/) (Influenced by)
+
 ## Installation
 
 Install the gem:
@@ -20,22 +31,14 @@ Setup your environment:
     cd site_name
     bin/setup
 
+You can push your project to any branch except `gh-pages`. For `sitename.github.io` repo users make sure to use another branch than `master`.
+
 ## Development
 
 Run Jekyll:
 
     bundle exec jekyll serve
 
-Used tools:
-  - [Autoprefixer](https://github.com/postcss/autoprefixer)
-  - [Bower](http://bower.io/)
-  - [Circle CI](https://circleci.com/)
-  - [Html-proofer](https://github.com/gjtorikian/html-proofer)
-  - [Jekyll](http://jekyllrb.com/)
-  - [Jekyll assets](https://github.com/jekyll/jekyll-assets)
-  - [Jekyll Sitemap](https://github.com/jekyll/jekyll-sitemap)
-  - [HTML5 Boilerplate](https://html5boilerplate.com/) (Influenced by)
-
 *If you do not want the Kickster setup but just the deploy scripts then copy them from the `bin` folder.*
 
 ## Deploy to GitHub Pages
@@ -44,7 +47,7 @@ Run this in the root project folder in your console:
 
     bin/deploy
 
-*Don't forget to enable your repository on [Circle CI](https://circleci.com/docs/getting-started) and update the `_config.yml` file!*
+*Don't forget to enable your repository on [Circle CI](https://circleci.com/docs/getting-started) and update the `_config.yml` file with your url!*
 
 ## Automated deployment with Circle CI
 
@@ -65,9 +68,19 @@ Replace your `circle.yml` file with [this](https://github.com/nielsenramon/kicks
 
 #### 3. Enable Circle CI.
 
-Make sure you enabled your repository on Circle CI. In Circle CI go to `Project settings > Checkout SSH Keys` and create a new User key. This is required to push to the GitHub repo from a script (permissions).
+Make sure you enabled your repository on Circle CI.
+After that we have to create a Read/Write deployment key. All 3 steps can be found [here](https://circleci.com/docs/adding-read-write-deployment-key/).
+
+In short:
+
+  1. Create a ssh key on your computer: `ssh-keygen -t rsa -b 4096 -C "your_email@example.com"` (leave the passphrase empty).
+
+  2. Create a new deploy key in your GitHub project and paste the public key in there and make sure you "Allow write access".
+
+  ![Enable Circle CI Step 2](https://raw.githubusercontent.com/nielsenramon/kickster/master/images/kickster-step2.png)
+  3. Create a new SSH key in the "SSH Permissions" tab under your project settings in Circle CI and paste the private key in there with the hostname: `github.com`.
 
-<img src="https://dl.dropboxusercontent.com/u/20823269/kickster-circle.jpg" alt="Screenshot of user key creating in Circle CI">
+  ![Enable Circle CI Step 3](https://raw.githubusercontent.com/nielsenramon/kickster/master/images/kickster-step3.png)
 
 That's it, start pushing changes and enjoy your automated deployments from now on!
 

data/circle.yml

@@ -1,6 +1,6 @@
 machine:
   ruby:
-    version: 2.4.0
+    version: 2.4.1
 
 dependencies:
   pre:
@@ -13,4 +13,4 @@ test:
     - ls -al
     - cd test && bin/setup
     - cd test && bundle exec jekyll build
-    - cd test && bundle exec htmlproofer ./_site --only-4xx --allow-hash-href
+    - cd test && bundle exec htmlproofer ./_site --only-4xx --allow-hash-href --assume-extension --check-opengraph

data/lib/kickster/version.rb

@@ -1,3 +1,3 @@
 module Kickster
-  VERSION = "1.5.0"
+  VERSION = "2.0.0"
 end

data/snippets/travis/README.md

@@ -29,7 +29,7 @@ This is required to push to the GitHub repo from a script.
 In GitHub go to `settings > Personal access tokens` and create a new one.
 First give it a proper name so it is easy to recognize later. Then check `repo` (check `public_repo` if it is a public repository) and click on create.
 
-<img src="https://dl.dropboxusercontent.com/u/20823269/kickster-token.png" alt="Screenshot of token generation in GitHub">
+![Enable Circle CI Step 2](https://raw.githubusercontent.com/nielsenramon/kickster/master/images/kickster-token.png)
 
 Copy the generated token.
 

data/template/.gitignore

@@ -4,4 +4,3 @@
 /.asset-cache/*
 /_assets/bower/*
 /_site/*
-/_vendor/*

data/template/.ruby-version

@@ -1 +1 @@
-2.4.0
+2.4.1

data/template/README.md.tt

@@ -2,25 +2,28 @@
 
 ## Installation
 
+Install the gem:
+
+    gem install kickster
+
+Execute gem and scaffold Kickster files:
+
+    kickster new site_name
+
 Setup your environment:
 
+    cd site_name
     bin/setup
 
+You can push your project to any branch except `gh-pages`. For `sitename.github.io` repo users make sure to use another branch than `master`.
+
 ## Development
 
 Run Jekyll:
 
     bundle exec jekyll serve
 
-Used tools:
-  - [Autoprefixer](https://github.com/postcss/autoprefixer)
-  - [Bower](http://bower.io/)
-  - [Circle CI](https://circleci.com/)
-  - [Html-proofer](https://github.com/gjtorikian/html-proofer)
-  - [Jekyll](http://jekyllrb.com/)
-  - [Jekyll assets](https://github.com/jekyll/jekyll-assets)
-  - [Jekyll Sitemap](https://github.com/jekyll/jekyll-sitemap)
-  - [HTML5 Boilerplate](https://html5boilerplate.com/) (Influenced by)
+*If you do not want the Kickster setup but just the deploy scripts then copy them from the `bin` folder.*
 
 ## Deploy to GitHub Pages
 
@@ -28,4 +31,4 @@ Run this in the root project folder in your console:
 
     bin/deploy
 
-[View this](https://github.com/nielsenramon/kickster#automated-deployment-with-circle-ci) for more info about automated deployment with Circle CI.
+*Don't forget to enable your repository on [Circle CI](https://circleci.com/docs/getting-started) and update the `_config.yml` file with your url!*

data/template/bin/deploy

@@ -2,9 +2,19 @@
 
 # Run this script to deploy the app to Github Pages.
 
+RED='\033[0;31m'
+
 # Exit if any subcommand fails.
 set -e
 
+# Check if any changes are uncommited.
+if ! git diff-files --quiet --ignore-submodules --
+then
+  echo >&2 "${RED}Please commit your changes first before deploying!"
+  git diff-files --name-status -r --ignore-submodules -- >&2
+  exit 0
+fi
+
 echo "Started deploying"
 
 # Checkout gh-pages branch.

data/template/bower.json.tt

@@ -1,6 +1,6 @@
 {
   "name": "<%= snake_name %>",
   "dependencies": {
-    "jquery": "~3.1.1"
+    "jquery": "~3.2.1"
   }
 }

data/template/circle.yml

@@ -1,6 +1,6 @@
 machine:
   ruby:
-    version: 2.4.0
+    version: 2.4.1
 
 dependencies:
   pre:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kickster
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Nielsen Ramon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-15 00:00:00.000000000 Z
+date: 2017-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -68,6 +68,9 @@ files:
 - Rakefile
 - bin/kickster
 - circle.yml
+- images/kickster-step2.png
+- images/kickster-step3.png
+- images/kickster-token.png
 - kickster.gemspec
 - lib/kickster.rb
 - lib/kickster/generator.rb