falkorlib 0.8.5 → 0.8.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/lib/falkorlib/bootstrap/base.rb +20 -13
- data/lib/falkorlib/bootstrap/git.rb +5 -2
- data/lib/falkorlib/bootstrap/mkdocs.rb +3 -4
- data/lib/falkorlib/bootstrap/vagrant.rb +9 -3
- data/lib/falkorlib/cli.rb +34 -175
- data/lib/falkorlib/cli/link.rb +5 -1
- data/lib/falkorlib/cli/make.rb +15 -1
- data/lib/falkorlib/cli/new.rb +22 -5
- data/lib/falkorlib/tasks/rspec.rake +29 -9
- data/lib/falkorlib/version.rb +1 -1
- data/spec/falkorlib/bootstrap_spec.rb +26 -1
- data/spec/falkorlib/bootstrap_vagrant_spec.rb +14 -14
- data/templates/README/header_readme.erb +18 -21
- data/templates/README/readme_pyenv.erb +44 -0
- data/templates/mkdocs/docs/README.md.erb +7 -7
- data/templates/mkdocs/docs/contributing/setup.md.erb +3 -3
- data/templates/mkdocs/docs/layout.md.erb +25 -4
- data/templates/mkdocs/docs/setup.md.erb +315 -0
- data/templates/mkdocs/docs/vagrant.md.erb +85 -0
- data/templates/mkdocs/mkdocs.yml.erb +5 -4
- data/templates/vagrant/Vagrantfile.erb +73 -28
- data/templates/vagrant/vagrant/config.yaml.sample +8 -4
- data/templates/vagrant/vagrant/puppet/Makefile +40 -0
- data/templates/vagrant/vagrant/puppet/hiera.yaml +36 -0
- data/templates/vagrant/vagrant/puppet/hieradata/.gitignore +2 -0
- data/templates/vagrant/vagrant/puppet/hieradata/defaults.yaml +4 -0
- data/templates/vagrant/vagrant/puppet/hieradata/roles/example.yaml +13 -0
- data/templates/vagrant/vagrant/puppet/manifests/default.pp +23 -0
- data/templates/vagrant/vagrant/puppet/modules/.gitignore +3 -0
- data/templates/vagrant/vagrant/puppet/site/profiles/manifests/pxe/server.pp +12 -0
- data/templates/vagrant/vagrant/{bootstrap.sh → scripts/bootstrap.sh} +27 -30
- data/templates/vagrant/vagrant/shared/.gitignore +3 -0
- metadata +15 -6
- data/templates/mkdocs/docs/setup/README.md.erb +0 -6
- data/templates/mkdocs/docs/setup/install.md.erb +0 -61
- data/templates/mkdocs/docs/setup/preliminaries.md.erb +0 -73
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: falkorlib
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.8.
|
4
|
+
version: 0.8.6
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Sebastien Varrette
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-04-
|
11
|
+
date: 2020-04-20 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: rake
|
@@ -448,6 +448,7 @@ files:
|
|
448
448
|
- templates/README/readme_issues.erb
|
449
449
|
- templates/README/readme_latex.erb
|
450
450
|
- templates/README/readme_mkdocs.erb
|
451
|
+
- templates/README/readme_pyenv.erb
|
451
452
|
- templates/README/readme_rvm.erb
|
452
453
|
- templates/Rakefile/footer_rakefile.erb
|
453
454
|
- templates/Rakefile/header_rakefile.erb
|
@@ -495,9 +496,8 @@ files:
|
|
495
496
|
- templates/mkdocs/docs/contributing/setup.md.erb
|
496
497
|
- templates/mkdocs/docs/contributing/versioning.md.erb
|
497
498
|
- templates/mkdocs/docs/layout.md.erb
|
498
|
-
- templates/mkdocs/docs/setup
|
499
|
-
- templates/mkdocs/docs/
|
500
|
-
- templates/mkdocs/docs/setup/preliminaries.md.erb
|
499
|
+
- templates/mkdocs/docs/setup.md.erb
|
500
|
+
- templates/mkdocs/docs/vagrant.md.erb
|
501
501
|
- templates/mkdocs/mkdocs.yml.erb
|
502
502
|
- templates/motd/motd.erb
|
503
503
|
- templates/puppet/modules/.gitignore
|
@@ -532,9 +532,18 @@ files:
|
|
532
532
|
- templates/puppet/modules/tests/vagrant/puppet_modules_setup.rb
|
533
533
|
- templates/python/setup.sh.erb
|
534
534
|
- templates/vagrant/Vagrantfile.erb
|
535
|
-
- templates/vagrant/vagrant/bootstrap.sh
|
536
535
|
- templates/vagrant/vagrant/config.yaml
|
537
536
|
- templates/vagrant/vagrant/config.yaml.sample
|
537
|
+
- templates/vagrant/vagrant/puppet/Makefile
|
538
|
+
- templates/vagrant/vagrant/puppet/hiera.yaml
|
539
|
+
- templates/vagrant/vagrant/puppet/hieradata/.gitignore
|
540
|
+
- templates/vagrant/vagrant/puppet/hieradata/defaults.yaml
|
541
|
+
- templates/vagrant/vagrant/puppet/hieradata/roles/example.yaml
|
542
|
+
- templates/vagrant/vagrant/puppet/manifests/default.pp
|
543
|
+
- templates/vagrant/vagrant/puppet/modules/.gitignore
|
544
|
+
- templates/vagrant/vagrant/puppet/site/profiles/manifests/pxe/server.pp
|
545
|
+
- templates/vagrant/vagrant/scripts/bootstrap.sh
|
546
|
+
- templates/vagrant/vagrant/shared/.gitignore
|
538
547
|
homepage: https://github.com/Falkor/falkorlib
|
539
548
|
licenses:
|
540
549
|
- MIT
|
@@ -1,6 +0,0 @@
|
|
1
|
-
|
2
|
-
This directory holds the documentation to properly setup the <%= config[:name] %> project on your machine.
|
3
|
-
In particular, check the following resources:
|
4
|
-
|
5
|
-
* [Pre-requisites / Preliminary software](preliminaries.md) to install
|
6
|
-
* How to [Clone and Setup](install.md) your local copy of this repository
|
@@ -1,61 +0,0 @@
|
|
1
|
-
<% unless config[:forge].empty? %>
|
2
|
-
|
3
|
-
This repository is hosted on [<%= FalkorLib::Config::Bootstrap::DEFAULTS[:forge][ config[:forge].to_sym ][:name] %>](<%= config[:project_page] %>).
|
4
|
-
|
5
|
-
<% if (config[:forge] == :gitlab) %>
|
6
|
-
* Git interactions with this repository (push, pull etc.) are performed over SSH using the port 8022
|
7
|
-
<% end %>
|
8
|
-
* To clone this repository, proceed as follows (adapt accordingly):
|
9
|
-
|
10
|
-
$> mkdir -p ~/git/<%= FalkorLib::Config::Bootstrap::DEFAULTS[:forge][ config[:forge].to_sym ][:url] %>/<%= config[:by] %>
|
11
|
-
$> cd ~/git/<%= FalkorLib::Config::Bootstrap::DEFAULTS[:forge][ config[:forge].to_sym ][:url] %>/<%= config[:by] %>
|
12
|
-
$> git clone <%= config[:origin] %>
|
13
|
-
<% end %>
|
14
|
-
|
15
|
-
<% if config[:type].include?( :rvm ) %>
|
16
|
-
Now ensure [RVM](https://rvm.io/) is correctly configured for this repository:
|
17
|
-
|
18
|
-
$> rvm current
|
19
|
-
|
20
|
-
Configure the dependencies detailed in the [`Gemfile`](Gemfile) through the [Bundler](http://bundler.io/):
|
21
|
-
|
22
|
-
$> gem install bundler
|
23
|
-
$> bundle install
|
24
|
-
$> rake -T # should work ;)
|
25
|
-
<% end %>
|
26
|
-
|
27
|
-
**`/!\ IMPORTANT`**: Once cloned, initiate your local copy of the repository by running:
|
28
|
-
|
29
|
-
$> cd <%= name.downcase %>
|
30
|
-
<% if config[:make] %>
|
31
|
-
$> make setup
|
32
|
-
<% else %>
|
33
|
-
$> rake setup
|
34
|
-
<% end %>
|
35
|
-
|
36
|
-
This will initiate the [Git submodules of this repository](.gitmodules), setup the [git flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) layout for this repository.
|
37
|
-
Later on, instead of pulling, you may want you can update **all** of your local branches by running:
|
38
|
-
|
39
|
-
```
|
40
|
-
make up
|
41
|
-
```
|
42
|
-
|
43
|
-
If upon pulling the repository, you end in a state where another collaborator have upgraded the Git submodules for this repository, you'll end in a dirty state (as reported by modifications within the `.submodules/` directory). In that case, just after the pull, you **have to run** the following command to ensure consistency with regards the Git submodules:
|
44
|
-
|
45
|
-
```bash
|
46
|
-
<% if config[:make] %>
|
47
|
-
$> make update # OR make up
|
48
|
-
<% else %>
|
49
|
-
$> rake git:submodules:update
|
50
|
-
<% end %>
|
51
|
-
# OR
|
52
|
-
git submodule update
|
53
|
-
```
|
54
|
-
|
55
|
-
finally, if you want to upgrade the [Git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) (see `.gitmodules`) to the latest version by running:
|
56
|
-
|
57
|
-
<% if options[:make] %>
|
58
|
-
$> make upgrade
|
59
|
-
<% else %>
|
60
|
-
$> rake git:submodules:upgrade
|
61
|
-
<% end %>
|
@@ -1,73 +0,0 @@
|
|
1
|
-
|
2
|
-
This projects relies on several components you need to have installed on your system.
|
3
|
-
|
4
|
-
* [Git](https://git-scm.com/)
|
5
|
-
|
6
|
-
The below instructions will help you to install these components, depending on your running platform.
|
7
|
-
|
8
|
-
_Note_: in the following instructions, terminal commands are prefixed by a virtual prompt `$>`which obviously **does not** belong to the command.
|
9
|
-
|
10
|
-
## Pre-requisites
|
11
|
-
|
12
|
-
* Install the following software, depending on your running platform:
|
13
|
-
|
14
|
-
| Platform | Software | Description | Usage |
|
15
|
-
|----------|-------------------------------------------------------|---------------------------------------|-------------------------|
|
16
|
-
| Mac OS | [Homebrew](http://brew.sh/) | The missing package manager for macOS | `brew install ...` |
|
17
|
-
| Mac OS | [Brew Cask Plugin](https://caskroom.github.io) | Mac OS Apps install made easy | `brew cask install ...` |
|
18
|
-
| Mac OS | [iTerm2](https://www.iterm2.com/) | _(optional)_ enhanced Terminal | |
|
19
|
-
| Windows | [Git for Windows](https://git-for-windows.github.io/) | I'm sure you guessed | |
|
20
|
-
| Windows | [SourceTree](https://www.sourcetreeapp.com/) | _(optional)_ enhanced git GUI | |
|
21
|
-
| Windows | [Virtual Box](https://www.virtualbox.org/) | Free hypervisor provider for Vagrant | |
|
22
|
-
| Windows | [Vagrant](https://www.vagrantup.com/downloads.html) | Reproducible environments made easy. | |
|
23
|
-
|
24
|
-
|
25
|
-
* Follow the below custom instructions depending on your running platform
|
26
|
-
|
27
|
-
### Mac OS X
|
28
|
-
|
29
|
-
Now that you have [Homebrew](http://brew.sh/) installed:
|
30
|
-
|
31
|
-
~~~bash
|
32
|
-
$> brew install git-core git-flow # (newer) Git stuff
|
33
|
-
~~~
|
34
|
-
|
35
|
-
### Linux (Debian / Ubuntu)
|
36
|
-
|
37
|
-
~~~bash
|
38
|
-
$> sudo apt-get update
|
39
|
-
$> sudo apt-get install git build-essential
|
40
|
-
~~~
|
41
|
-
|
42
|
-
Adapt the package names (and package manager) in case you are using another Linux distribution.
|
43
|
-
|
44
|
-
|
45
|
-
### Windows
|
46
|
-
|
47
|
-
Follow the instructions provided on this [tutorial](http://rr-tutorials.readthedocs.io/en/latest/setup/#windows).
|
48
|
-
In particular, it may be a good idea to rely on [Vagrant](https://www.vagrantup.com/) to run a Linux box.
|
49
|
-
|
50
|
-
|
51
|
-
## Post-Installations checks
|
52
|
-
|
53
|
-
(Eventually) Make yourself known to Git
|
54
|
-
|
55
|
-
~~~bash
|
56
|
-
$> git config –-global user.name "Firstname LastName" # Adapt accordingly
|
57
|
-
$> git config –-global user.email "Firstname.LastName@domain.org" # Adapt with your mail
|
58
|
-
~~~
|
59
|
-
|
60
|
-
<% unless config[:forge].empty? %>
|
61
|
-
Clone the [project repository](<%= FalkorLib::Config::Bootstrap::DEFAULTS[:forge][ config[:forge].to_sym ][:name] %><%= config[:project_page] %> from a Terminal (Powershell as `administrator` under windows):
|
62
|
-
|
63
|
-
~~~bash
|
64
|
-
$> mkdir -p ~/git/<%= FalkorLib::Config::Bootstrap::DEFAULTS[:forge][ config[:forge].to_sym ][:url] %>/<%= config[:by] %>
|
65
|
-
$> cd ~/git/<%= FalkorLib::Config::Bootstrap::DEFAULTS[:forge][ config[:forge].to_sym ][:url] %>/<%= config[:by] %>
|
66
|
-
$> git clone <%= config[:origin] %>
|
67
|
-
<% if config[:make] %>
|
68
|
-
$> make setup # Under Mac OS / Linux
|
69
|
-
<% else %>
|
70
|
-
$> rake setup # Under Mac OS / Linux
|
71
|
-
<% end %>
|
72
|
-
~~~
|
73
|
-
<% end %>
|