README.md in itamae-plugin-recipe-gitlab_runner-0.1.0 vs README.md in itamae-plugin-recipe-gitlab_runner-0.2.0
- old
+ new
@@ -1,9 +1,10 @@
# Itamae::Plugin::Recipe::GitlabRunner
Itamae plugin to install [GitLab Runner](https://docs.gitlab.com/runner/)
+[](https://badge.fury.io/rb/itamae-plugin-recipe-gitlab_runner)
[](https://travis-ci.org/sue445/itamae-plugin-recipe-gitlab_runner)
## Installation
Add this line to your application's Gemfile:
@@ -29,21 +30,43 @@
Or `include_recipe` just what you need manually:
```ruby
include_recipe "gitlab_runner::install"
+include_recipe "gitlab_runner::register_gitlab_runner"
```
-After, you need to register a runner
-
-https://docs.gitlab.com/runner/register/index.html
-
### Node
```yml
# node.yml
gitlab-runner:
version: "10.0.0" # optional. Install latest version if omitted
+```
+
+### `register_gitlab_runner`
+Register a gitlab_runner
+
+* `name` (`String`)
+ * runner name
+* `options` (`Array`, `String`)
+ * args for `gitlab-runner register`
+ * `--non-interactive`, `--name` and `--description` are needless
+ * c.f. https://docs.gitlab.com/runner/register/#one-line-registration-command
+
+e.g)
+
+```ruby
+register_gitlab_runner "docker-runner" do
+ options [
+ "--url", "https://gitlab.com/",
+ "--registration-token", "PROJECT_REGISTRATION_TOKEN",
+ "--executor", "docker",
+ "--tag-list", "docker,aws",
+ "--run-untagged",
+ "--locked", "false",
+ ]
+end
```
## 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.