Skip to content

Commit 71155c2

Browse files
authored
Merge pull request #11 from Invoca/non-production/fix-typo
non-production: non-prod: [fix] update to WARNING: DO NOT EDIT THIS FILE
2 parents 2bd106d + 93fb1e6 commit 71155c2

File tree

3 files changed

+12
-8
lines changed

3 files changed

+12
-8
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,14 @@ configuration for various deployment environments.
77
## Installation
88

99
Install the gem and add to the application's Gemfile by executing:
10-
```
10+
11+
```bash
1112
bundle add kubernetes_template_rendering
1213
```
1314

1415
If bundler is not being used to manage dependencies, install the gem by executing:
15-
```
16+
17+
```bash
1618
gem install kubernetes_template_rendering
1719
```
1820

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

2527
### Example Usage
28+
2629
```bash
2730
gem exec -g kubernetes_template_rendering render_templates \
2831
--jsonnet-library-path deployment/vendor \
@@ -33,6 +36,7 @@ gem exec -g kubernetes_template_rendering render_templates \
3336
### Options
3437

3538
To see a full list of options and how to use them, run the following command:
39+
3640
```bash
3741
gem exec -g kubernetes_template_rendering render_templates --help
3842
```
@@ -45,4 +49,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
4549

4650
## Contributing
4751

48-
Bug reports and pull requests are welcome on GitHub at https://github.com/invoca/kubernetes_template_rendering.
52+
Bug reports and pull requests are welcome on GitHub at <https://github.com/invoca/kubernetes_template_rendering>.

lib/kubernetes_template_rendering/template.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ def render(args)
2525

2626
def with_auto_generated_yaml_comment(yaml_string)
2727
comment = <<~EOS
28-
# WARNING: DO NO EDIT THIS FILE!
28+
# WARNING: DO NOT EDIT THIS FILE!
2929
# Any changes made here will be lost.
3030
# This file is autogenerated from #{full_template_path}
3131
EOS

spec/kubernetes_template_rendering/template_spec.rb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929

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

@@ -101,7 +101,7 @@
101101
let(:hash) { { owner: "omega", namespace: "call-imports" } }
102102

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

@@ -151,9 +151,9 @@
151151
end
152152

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

0 commit comments

Comments
 (0)