Skip to content

Commit 7af8ebd

Browse files
committed
0.2.4:
- Bumped dependencies (upgraded to Jekyll 3.8.5) - Added NPM scripts - Updated readme to reflect switch to NPM scripts and asdf-vm to manage versions - Added asdf-vm .tool-versions
1 parent f769fa1 commit 7af8ebd

File tree

6 files changed

+74
-49
lines changed

6 files changed

+74
-49
lines changed

.tool-versions

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
nodejs 8.11.4
2+
ruby 2.5.3

Gemfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
source "https://rubygems.org"
22

3-
gem 'jekyll', '~> 3.8.3'
3+
gem 'jekyll', '~> 3.8.5'
44
gem 's3_website', '~> 3.4.0'

Gemfile.lock

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
11
GEM
22
remote: https://rubygems.org/
33
specs:
4-
addressable (2.5.2)
4+
addressable (2.6.0)
55
public_suffix (>= 2.0.2, < 4.0)
6-
aws-sdk (2.11.74)
7-
aws-sdk-resources (= 2.11.74)
8-
aws-sdk-core (2.11.74)
6+
aws-eventstream (1.0.2)
7+
aws-sdk (2.11.256)
8+
aws-sdk-resources (= 2.11.256)
9+
aws-sdk-core (2.11.256)
910
aws-sigv4 (~> 1.0)
1011
jmespath (~> 1.0)
11-
aws-sdk-resources (2.11.74)
12-
aws-sdk-core (= 2.11.74)
13-
aws-sigv4 (1.0.2)
12+
aws-sdk-resources (2.11.256)
13+
aws-sdk-core (= 2.11.256)
14+
aws-sigv4 (1.1.0)
15+
aws-eventstream (~> 1.0, >= 1.0.2)
1416
colorator (1.1.0)
1517
colored (1.2)
16-
concurrent-ruby (1.0.5)
18+
concurrent-ruby (1.1.5)
1719
configure-s3-website (2.3.0)
1820
aws-sdk (~> 2)
1921
deep_merge (~> 1.0.0)
@@ -23,12 +25,12 @@ GEM
2325
eventmachine (>= 0.12.9)
2426
http_parser.rb (~> 0.6.0)
2527
eventmachine (1.2.7)
26-
ffi (1.9.25)
28+
ffi (1.10.0)
2729
forwardable-extended (2.6.0)
2830
http_parser.rb (0.6.0)
2931
i18n (0.9.5)
3032
concurrent-ruby (~> 1.0)
31-
jekyll (3.8.3)
33+
jekyll (3.8.5)
3234
addressable (~> 2.4)
3335
colorator (~> 1.0)
3436
em-websocket (~> 0.5)
@@ -43,43 +45,43 @@ GEM
4345
safe_yaml (~> 1.0)
4446
jekyll-sass-converter (1.5.2)
4547
sass (~> 3.4)
46-
jekyll-watch (2.0.0)
48+
jekyll-watch (2.2.1)
4749
listen (~> 3.0)
4850
jmespath (1.4.0)
4951
kramdown (1.17.0)
50-
liquid (4.0.0)
52+
liquid (4.0.3)
5153
listen (3.1.5)
5254
rb-fsevent (~> 0.9, >= 0.9.4)
5355
rb-inotify (~> 0.9, >= 0.9.7)
5456
ruby_dep (~> 1.2)
5557
mercenary (0.3.6)
56-
pathutil (0.16.1)
58+
pathutil (0.16.2)
5759
forwardable-extended (~> 2.6)
58-
public_suffix (3.0.2)
60+
public_suffix (3.0.3)
5961
rb-fsevent (0.10.3)
60-
rb-inotify (0.9.10)
61-
ffi (>= 0.5.0, < 2)
62-
rouge (3.1.1)
62+
rb-inotify (0.10.0)
63+
ffi (~> 1.0)
64+
rouge (3.3.0)
6365
ruby_dep (1.5.0)
6466
s3_website (3.4.0)
6567
colored (= 1.2)
6668
configure-s3-website (= 2.3.0)
6769
dotenv (~> 1.0)
6870
thor (~> 0.18)
69-
safe_yaml (1.0.4)
70-
sass (3.5.6)
71+
safe_yaml (1.0.5)
72+
sass (3.7.4)
7173
sass-listen (~> 4.0.0)
7274
sass-listen (4.0.0)
7375
rb-fsevent (~> 0.9, >= 0.9.4)
7476
rb-inotify (~> 0.9, >= 0.9.7)
75-
thor (0.20.0)
77+
thor (0.20.3)
7678

7779
PLATFORMS
7880
ruby
7981

8082
DEPENDENCIES
81-
jekyll (~> 3.8.3)
83+
jekyll (~> 3.8.5)
8284
s3_website (~> 3.4.0)
8385

8486
BUNDLED WITH
85-
1.15.4
87+
2.0.1

README.md

Lines changed: 34 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -27,49 +27,63 @@ Jekyll + Gulp.js + BrowserSync + PostCSS + Stylelint
2727

2828
## Prerequisites
2929

30-
Node.js (and npm, included), use [NVM](https://github.com/creationix/nvm) to install and manage versions. Currently tested with Node.js `v6.10.1` (LTS).
30+
> Note: Use [asdf-vm](https://github.com/asdf-vm/asdf) to install and manage versions of Node.js and Ruby. Alternatives like `NVM`, `nodenv`, and `rbenv` can be used as long as there’s a `.nvmrc`, `.ruby-version`, etc. file.
3131
32-
Ruby, use [rbenv](https://github.com/rbenv/rbenv) to install and manage versions. Currently tested with ruby `2.3.1p112`.
32+
**Node.js**. Currently developed against Node.js `8.11.4`.
3333

34-
[Bundler](https://github.com/bundler/bundler), install with:
34+
**Ruby**. Currently developed against ruby `2.5.3`.
35+
36+
[**Bundler**](https://github.com/bundler/bundler), install with:
3537

3638
```sh
3739
gem install bundler
3840
```
3941

40-
[bower](https://github.com/bower/bower), install with:
42+
## Installation
43+
44+
Clone the repository and change into the `gulp-jekyll` folder. Run:
4145

4246
```sh
43-
npm install -g bower
47+
bundle
48+
npm install
49+
npm run bower install
4450
```
4551

46-
## Installation
52+
## Setup
4753

48-
Clone the repository on your computer and change into the projects folder. Run:
54+
Open `gulp/config.js` and change settings if needed.
55+
56+
## Usage
57+
58+
Create development build with live-reload:
4959

5060
```sh
51-
$ bundle
52-
$ bower install
53-
$ npm install
61+
npm start
5462
```
5563

56-
## Setup
64+
Create production build with preview:
5765

58-
Open `gulp/config.js` and change settings if needed.
66+
```sh
67+
npm run build
68+
```
5969

60-
## Running Gulp.js
70+
Deploy latest production build through rsync:
6171

62-
Three tasks are available:
72+
```sh
73+
npm run stage
74+
```
75+
76+
Deploy latest production build on AWS:
6377

6478
```sh
65-
$ gulp
66-
$ gulp publish
67-
$ gulp deploy
79+
npm run s3:push
6880
```
6981

70-
- Running `gulp` will start a development server, build assets and the Jekyll site and start a `watch` task.
71-
- Running `gulp publish` will copy and optimize assets and run a production build of Jekyll.
72-
- Running `gulp deploy` will copy the generated files with Rsync to your server.
82+
Dry-run *(preview)* a deployment on AWS:
83+
84+
```sh
85+
npm run s3:dry
86+
```
7387

7488
## CSS File Organization
7589

app/.gitignore

Lines changed: 0 additions & 2 deletions
This file was deleted.

package.json

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
{
22
"name": "gulp-jekyll",
3-
"version": "0.2.3",
4-
"description": "The build process for gulp-jekyll",
3+
"version": "0.2.4",
4+
"description": "Build tooling for web development. Integrates Jekyll with Gulp, BrowserSync, PostCSS, Stylelint, and more.",
55
"author": "Michael Xander",
66
"repository": "michaelx/gulp-jekyll",
77
"devDependencies": {
8+
"bower": "^1.8.4",
89
"browser-sync": "^2.24.6",
910
"browserify": "^16.2.2",
1011
"browserify-shim": "^3.8.14",
11-
"css-mqpacker": "^6.0.2",
12+
"css-mqpacker": "^7.0.0",
1213
"cssnano": "^3.10.0",
1314
"del": "^3.0.0",
1415
"fancy-log": "^1.3.2",
@@ -63,5 +64,13 @@
6364
"browserslist": [
6465
"last 2 versions",
6566
"IE 10"
66-
]
67+
],
68+
"scripts": {
69+
"bower": "bower",
70+
"start": "gulp",
71+
"build": "gulp publish",
72+
"stage": "gulp stage",
73+
"s3:push": "bundle exec s3_website push",
74+
"s3:dry": "bundle exec s3_website push --dry-run"
75+
}
6776
}

0 commit comments

Comments
 (0)