Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,14 @@ configuration for various deployment environments.
## Installation

Install the gem and add to the application's Gemfile by executing:
```

```bash
bundle add kubernetes_template_rendering
```

If bundler is not being used to manage dependencies, install the gem by executing:
```

```bash
gem install kubernetes_template_rendering
```

Expand All @@ -23,6 +25,7 @@ To use this gem you can either install it, and use the `render_kubernetes_templa
`gem exec` to execute the command without first installing the gem.

### Example Usage

```bash
gem exec -g kubernetes_template_rendering render_templates \
--jsonnet-library-path deployment/vendor \
Expand All @@ -33,6 +36,7 @@ gem exec -g kubernetes_template_rendering render_templates \
### Options

To see a full list of options and how to use them, run the following command:

```bash
gem exec -g kubernetes_template_rendering render_templates --help
```
Expand All @@ -45,4 +49,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/invoca/kubernetes_template_rendering.
Bug reports and pull requests are welcome on GitHub at <https://github.com/invoca/kubernetes_template_rendering>.
2 changes: 1 addition & 1 deletion lib/kubernetes_template_rendering/template.rb
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ def render(args)

def with_auto_generated_yaml_comment(yaml_string)
comment = <<~EOS
# WARNING: DO NO EDIT THIS FILE!
# WARNING: DO NOT EDIT THIS FILE!
# Any changes made here will be lost.
# This file is autogenerated from #{full_template_path}
EOS
Expand Down
8 changes: 4 additions & 4 deletions spec/kubernetes_template_rendering/template_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

it "adds a magic autogenerated comment with warning to not modify" do
return_erb_on_file_read
expect(render_template).to include("# WARNING: DO NO EDIT THIS FILE!")
expect(render_template).to include("# WARNING: DO NOT EDIT THIS FILE!")
expect(render_template).to include("# This file is autogenerated from #{path}")
end

Expand Down Expand Up @@ -101,7 +101,7 @@
let(:hash) { { owner: "omega", namespace: "call-imports" } }

it "adds magic comment about being autogenerated and has a warning to not edit" do
expect(render_template).to include("# WARNING: DO NO EDIT THIS FILE!")
expect(render_template).to include("# WARNING: DO NOT EDIT THIS FILE!")
expect(render_template).to include("# This file is autogenerated from #{path}")
end

Expand Down Expand Up @@ -151,9 +151,9 @@
end

it "adds magic comments to each yaml file rendered" do
expect(render_template["service.yaml"]).to include("# WARNING: DO NO EDIT THIS FILE!")
expect(render_template["service.yaml"]).to include("# WARNING: DO NOT EDIT THIS FILE!")
expect(render_template["service.yaml"]).to include("# This file is autogenerated from #{path}")
expect(render_template["pnapi-service-monitor.yaml"]).to include("# WARNING: DO NO EDIT THIS FILE!")
expect(render_template["pnapi-service-monitor.yaml"]).to include("# WARNING: DO NOT EDIT THIS FILE!")
expect(render_template["pnapi-service-monitor.yaml"]).to include("# This file is autogenerated from #{path}")
end
end
Expand Down