Skip to content

Commit d135296

Browse files
author
Patrick Schaumburg
authored
Update cookbook with latest alignments + styles (#8)
* cookstyle lints + alignments to tecRacer OS standards * update md files * renaming + adding kitchen configs * add amazon to recipe + add centos-6 to kitchen * add centos-6 to dokken * fix pid_one_command for centos-6 * add github templates * remove amazon linux + centos-6 from kitchen testing * add codeowners * update to version 3.0.0 * fix small wrong alignments and versions * fix dokken env
1 parent 15a6f51 commit d135296

21 files changed

+439
-82
lines changed

.github/CODEOWNERS

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Order is important. The last matching pattern has the most precedence.
2+
3+
* @tecracer-chef-cookbooks/tr-opensource-maintainer
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: 🐛 Bug Report
3+
about: If something isn't working as expected 🤔.
4+
labels: "bug"
5+
---
6+
7+
### Cookbook version
8+
[Version of the cookbook where you are encountering the issue]
9+
10+
### Chef-client version
11+
[Version of chef-client in your environment]
12+
13+
### Platform Details
14+
[Operating system distribution and release version. Cloud provider if running in the cloud]
15+
16+
### Scenario:
17+
[What you are trying to achieve and you can't?]
18+
19+
### Steps to Reproduce:
20+
[If you are filing an issue what are the things we need to do in order to repro your problem? How are you using this cookbook or any resources it includes?]
21+
22+
### Expected Result:
23+
[What are you expecting to happen as the consequence of above reproduction steps?]
24+
25+
### Actual Result:
26+
[What actually happens after the reproduction steps? Include the error output or a link to a gist if possible.]
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: 🚀 Enhancement Request
3+
about: I have a suggestion (and may want to implement it 🙂)!
4+
labels: "new feature"
5+
---
6+
7+
### Describe the Enhancement:
8+
<!--- What you are trying to achieve that you can't? -->
9+
10+
### Describe the Need:
11+
<!--- What kind of user do you believe would utilize this enhancement, and how many users might want this functionality -->
12+
13+
### Current Alternative
14+
<!--- Is there a current alternative that you can utilize to workaround the lack of this enhancement -->
15+
16+
### Can We Help You Implement This?:
17+
<!--- The best way to ensure your enhancement is built is to help implement the enhancement yourself. If you're interested in helping out we'd love to give you a hand to make this possible. Let us know if there's something you need. -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
### Description
2+
3+
[Describe what this change achieves]
4+
5+
### Issues Resolved
6+
7+
[List any existing issues this PR resolves]
8+
9+
### Check List
10+
11+
- [ ] All tests pass.
12+
- [ ] New functionality includes testing.
13+
- [ ] New functionality has been documented in the README if applicable

.github/workflows/kitchen-test.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: kitchen-test
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- master
8+
9+
jobs:
10+
dokken:
11+
runs-on: ubuntu-latest
12+
strategy:
13+
matrix:
14+
os: ['amazon2', 'centos-7', 'centos-8', 'debian-9', 'debian-10', 'opensuse-leap-15', 'ubuntu-1604', 'ubuntu-1804', 'ubuntu-2004']
15+
suite: ['default']
16+
fail-fast: false
17+
steps:
18+
- name: Check out code
19+
uses: actions/checkout@master
20+
- name: Install Chef
21+
uses: actionshub/chef-install@master
22+
- name: Run test-kitchen
23+
run: |
24+
kitchen test ${SUITE}-${OS} -d always
25+
env:
26+
SUITE: ${{matrix.suite}}
27+
OS: ${{matrix.os}}
28+
CHEF_LICENSE: accept-no-persist
29+
KITCHEN_LOCAL_YAML: kitchen.dokken.yml

.github/workflows/linting.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: linting
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- master
8+
9+
jobs:
10+
cookstyle:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Check out code
14+
uses: actions/checkout@master
15+
- name: Install Chef
16+
uses: actionshub/chef-install@master
17+
- name: Run cookstyle
18+
run: cookstyle
19+
env:
20+
CHEF_LICENSE: accept-no-persist
21+
mdl:
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Check out code
25+
uses: actions/checkout@master
26+
- name: Run Markdown Lint
27+
uses: actionshub/markdownlint@master

.ruby-version

Lines changed: 0 additions & 1 deletion
This file was deleted.

CHANGELOG.md

Lines changed: 27 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,37 @@
1-
# Change Log
1+
# Changelog
22

3-
## [v1.1.0](https://github.com/jjasghar/chef-vmware-tools/tree/v1.1.0)
3+
## [3.0.0] - 2020-05-06
44

5-
[Full Changelog](https://github.com/jjasghar/chef-vmware-tools/compare/v1.0.1...v1.1.0)
5+
* update minimum required chef version to 15.0 (BREAKING CHANGE)
6+
* update metadata.rb with new contents
7+
* update attributes + recipe files with style fixes
8+
* update changelog, contributing, readme and testing
9+
* add GitHub templates for bugs and pull requests
10+
* add GitHub Actions for linting and kitchen test
11+
* add Codeowners
12+
* add kitchen configs for ec2, dokken, vra
13+
* rename .kitchen files to kitchen
14+
* remove .ruby-version
615

7-
**Merged pull requests:**
16+
## [2.1.0] - 2018-05-21
817

9-
- Added always be updating. [\#2](https://github.com/jjasghar/chef-vmware-tools/pull/2) ([jjasghar](https://github.com/jjasghar))
18+
* Bumped version of windows tools
1019

11-
## [v1.0.1](https://github.com/jjasghar/chef-vmware-tools/tree/v1.0.1) (2018-02-05)
12-
[Full Changelog](https://github.com/jjasghar/chef-vmware-tools/compare/v1.0.0...v1.0.1)
20+
## [2.0.0] - 2018-04-23
1321

14-
## [v1.0.0](https://github.com/jjasghar/chef-vmware-tools/tree/v1.0.0) (2018-02-05)
15-
**Merged pull requests:**
22+
* First pass at the windows rebooting.
1623

17-
- 1.0.0 Release [\#1](https://github.com/jjasghar/chef-vmware-tools/pull/1) ([jjasghar](https://github.com/jjasghar))
24+
## [1.1.0] - 2018-02-06
1825

26+
* Added a flag to change to update always, instead of just installing.
1927

28+
## [1.0.1] - 2018-02-06
2029

21-
\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
30+
* Added always be updating
31+
32+
## [1.0.0] - 2018-02-05
33+
34+
* Updated cookbook to open-vm-tools
35+
* Updated for both Debian and RPM based distros
36+
* Added Windows support
37+
* Added tests and test-kitchen support

CONTRIBUTING.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1-
Contributing
2-
============
1+
# Contributing
2+
3+
---
34

45
Steps
5-
-----
66

7-
Thanks for your interest in gelsinger! If you'd like to help out please:
7+
---
8+
9+
Thanks for your interest in contributing! If you'd like to help out please:
810

911
1. Fork it
10-
2. Create your feature branch (`git checkout -b my-new-feature`)
11-
3. Add tests for the new feature; ensure they pass (`rake`)
12-
4. Commit your changes (`git commit -am 'Add some feature'`)
13-
5. Push to the branch (`git push origin my-new-feature`)
14-
6. Create a new Pull Request
12+
1. Create your feature branch (`git checkout -b my-new-feature`)
13+
1. Add tests for the new feature; ensure they pass (`rake`)
14+
1. Commit your changes (`git commit -am 'Add some feature'`)
15+
1. Push to the branch (`git push origin my-new-feature`)
16+
1. Create a new Pull Request

README.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,38 +6,44 @@ Chef cookbook for installing [VMware tools](https://docs.vmware.com/en/VMware-To
66

77
## Attributes
88

9-
- `default['vmware-tools']['update']` - default set to `true`, you know you want the newest _always_.
10-
- `default['vmware-tools']['windows_reboot']` - default set to `true`, and if put at the first cookbook you'll reboot then run the rest of the `run_list`.
11-
- `default['vmware-tools']['url']` - The location to get the Windows VMware-Tools executable from.
12-
- `default['vmware-tools']['version']` - The version of the Windows VMware-Tool.
9+
- `default['vmware-tools']['update']` - default set to `true`, you know you want
10+
the newest _always_.
11+
- `default['vmware-tools']['windows_reboot']` - default set to `true`, and if
12+
put at the first cookbook you'll reboot then run the rest of the `run_list`.
13+
- `default['vmware-tools']['url']` - The location to get the Windows VMware-Tools
14+
executable from.
15+
- `default['vmware-tools']['version']` - The version of the Windows VMware-Tools.
1316

1417
## Usage
1518

1619
### vmware-tools::default
1720

18-
The default recipe will install [open-vm-tools](https://github.com/vmware/open-vm-tools) of on a CentOS/Debian based machine. If you run this on Windows it install the public VMware Tools executable from https://packages.vmware.com.
21+
The default recipe will install [open-vm-tools](https://github.com/vmware/open-vm-tools)
22+
of on a CentOS/Debian based machine. If you run this on Windows it installs the
23+
public VMware Tools executable from [packages.vmware.com](https://packages.vmware.com).
1924

20-
If you have a specific place you want to install your Windows based VMware Tools from, override the `default['vmware-tools']['url']` and `default['vware-tools']['version']` in the default attributes.
25+
If you have a specific place you want to install your Windows based VMware Tools
26+
from, override the `default['vmware-tools']['url']`
27+
and `default['vware-tools']['version']` in the default attributes.
2128

2229
## Testing
2330

2431
For more details look at the [TESTING.md](./TESTING.md).
2532

2633
## License & Authors
2734

28-
If you would like to see the detailed LICENCE click [here](./LICENCE).
35+
**Author:** tecRacer Opensource Team ([opensource@tecracer.de](mailto:opensource@tecracer.de))
36+
**Original Author:** JJ Asghar [GitHub](https://github.com/jjasghar)
37+
**Original Author:** Andrew Fraley [GitHub](https://github.com/andrewfraley/)
2938

30-
- Author: JJ Asghar <jj@chef.io>
31-
- Author: https://github.com/andrewfraley/
32-
33-
```text
34-
Copyright:: JJ Asghar
39+
**Copyright:** 2020, tecRacer Group
3540

41+
```
3642
Licensed under the Apache License, Version 2.0 (the "License");
3743
you may not use this file except in compliance with the License.
3844
You may obtain a copy of the License at
3945
40-
http://www.apache.org/licenses/LICENSE-2.0
46+
http://www.apache.org/licenses/LICENSE-2.0
4147
4248
Unless required by applicable law or agreed to in writing, software
4349
distributed under the License is distributed on an "AS IS" BASIS,

0 commit comments

Comments
 (0)