Commit graph

144 commits

Author SHA1 Message Date
Clinton Wolfe
6b75b9350d
Apply suggestion from docs team
Signed-off-by: Clinton Wolfe clintoncwolfe@gmail.com

Co-authored-by: Ian Maddaus <IanMadd@users.noreply.github.com>
2021-03-10 12:12:44 -05:00
Clinton Wolfe
7060ff7bf2 Update README to add note about Ruby 2.5 support
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2021-03-03 12:05:44 -05:00
Clinton Wolfe
fc5e22f595 Update minimum ruby version in README
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2021-01-12 15:14:57 -05:00
Tim Smith
a77f1c7460 Remove macOS 10.13 from the build matrix
We support N-2 builds and now that Big Sur is out we can remove 10.13. I also cleaned up the supported platforms in the readme a bit.

Signed-off-by: Tim Smith <tsmith@chef.io>
2020-11-23 09:52:32 -08:00
IanMadd
6a592a6db2 Update various readmes and docs
Signed-off-by: IanMadd <imaddaus@chef.io>
2020-09-14 14:09:23 -07:00
Nick Schwaderer
286bb7c58a Puts together correct version of README
Signed-off-by: Nick Schwaderer <nschwaderer@chef.io>
2020-05-06 10:58:59 +01:00
Nick Schwaderer
85f76a8370 Updates README.md to clarify running InSpec local
When this part of the README was updated five years ago ( b58a4b3f43 ), the executable was to be found in `bin/inspec`. It has since been extracted to `inspec-bin/bin/inspec`.

This current phrasing could cause some confusion as a user might actually run `bundle install` from their root and try to then run `bin/inspec`.

This commit clarifies that you need to first `cd` down into `inspec-bin`

Signed-off-by: Nick Schwaderer <nschwaderer@chef.io>
2020-05-06 10:58:59 +01:00
Clinton Wolfe
0b2cd19946 Update SLAs
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2020-02-18 12:57:59 -05:00
Mary Jinglewski
5049975b0c Spacing Issue Fix
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
2020-01-21 16:14:32 -05:00
Mary Jinglewski
15337b2eb3 Additional Fix
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
2020-01-21 11:36:17 -05:00
Mary Jinglewski
cfd8445a99 Correction for over compensation
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
2020-01-17 16:37:41 -05:00
Mary Jinglewski
5074bf5190 Windows 7 and Windows 2008 EOL Docs Update
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
2020-01-17 16:27:00 -05:00
stephen mulcahy
48e0e4fd50
Fix broken link to Azure testing instructions 2020-01-08 17:39:29 +00:00
Clinton Wolfe
8f407e2387 Add platform detail to support info
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-08-08 17:28:34 -04:00
Miah Johnson
802918f569 point badge to master 2019-07-30 15:02:42 -07:00
Miah Johnson
c91d955039 Remove appveyor and travis badges; switch to buildkite
Signed-off-by: Miah Johnson <miah@chia-pet.org>
2019-07-29 17:40:41 -07:00
Jerry Aldrich
b7eb0f370f Add CLI target examples for Windows domain users
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2019-06-25 15:34:51 -07:00
Miah Johnson
6873bf1fb2
Update README.md
Co-Authored-By: mjingle <mjingle@users.noreply.github.com>
2019-05-30 10:57:58 -07:00
Clinton Wolfe
639c3a7489 Clarify gem install instructions regarding inspec-bin in README
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-05-30 10:43:18 -04:00
Mary Jinglewski
f4eca9b2bf Include info about Chef License Requirements
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
2019-05-15 16:31:59 -04:00
Miah Johnson
20bafdc4b2
Merge pull request #3988 from inspec/mj/coveralls
Add Coveralls.io support to InSpec
2019-05-08 12:58:00 -07:00
Clinton Wolfe
f402391c4e
OSS Rollout Updates (#3942)
OSS Rollout Updates
2019-05-08 15:48:16 -04:00
Mary Jinglewski
f196aa4985 Update software names in readme
Signed-off-by: Mary Jinglewski <mjinglewski@chef.io>
2019-05-01 14:14:59 -04:00
Miah Johnson
b1d5091670 Add Coveralls.io support to InSpec
Tie coveralls into simplecov formatters
Add coveralls badge to README

Signed-off-by: Miah Johnson <miah@chia-pet.org>
2019-04-26 13:37:55 -07:00
Miah Johnson
5f0c1fa7dc OSS Rollout Updates
Add Project State, and SLA to README
Update CODEOWNERS

Signed-off-by: Miah Johnson <miah@chia-pet.org>
2019-04-25 15:59:14 -07:00
Tim Smith
00ce6c02df Require Ruby 2.4 or later
Ruby 2.3 is no longer supported. Drop this release from InSpec and
instead support the 3 latest Ruby releases.

Signed-off-by: Tim Smith <tsmith@chef.io>
2019-04-16 21:19:40 -07:00
Clinton Wolfe
7380702ed7 Whitespace change for PR
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-04-01 16:05:08 -04:00
Tim Smith
95a25e719d Update support platforms in the readme
Long term we should fold this into the docs site and align it with our standard platform support policy, but this is less bad than it was before.

Signed-off-by: Tim Smith <tsmith@chef.io>
2019-02-13 15:51:26 -08:00
Clinton Wolfe
635cc58b77 Update Ruby requirement in README
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2019-01-29 15:44:48 -05:00
Clinton Wolfe
e24de171df
Add note to install from OS package when possible (#3686)
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-12-20 17:15:14 -05:00
Jared Quick
ac00b6d6f0
Rebuild Hab package. (#3670)
Signed-off-by: Jared Quick <jquick@chef.io>
2018-12-14 13:58:38 -05:00
Jerry Aldrich
4eb5f0eeb6 Remove Habitat package run time dependencies from Habitat plan (#3645)
* Remove Hab pkg deps in favor of OS binaries

This removes the runtime dependencies on Hab pkgs and instead modifies
the `PATH` environment variable to use the OS binaries where the InSpec
Habitat package is installed.

It should be noted that this is counter to what Habitat intends in most
cases. In general, it is preferable to use only Habitat packages as
runtime dependencies to get all the benefits that Habitat provides.

We elected not to do this for the InSpec Habitat package since the list
of binaries that would need to be installed to support all InSpec
resources would be prohibitively expensive (both in disk space and
network requirements). If you wish to use Habitat packaged binaries with
this package you can use `hab pkg install origin/my-binary --binlink`.

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>

* Modify Habitat install example to use `--binlink`

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>

* Add `core/git` runtime dep (used for fetching)

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-12-06 10:16:56 -05:00
Jared Quick
7cc8f8eaa8
bump version (#3569)
Signed-off-by: Jared Quick <jquick@chef.io>
2018-11-01 18:06:05 -04:00
Jared Quick
d1949b57e6
Bump minor via expeditor. (#3448)
Signed-off-by: Jared Quick <jquick@chef.io>
2018-09-26 16:34:04 -04:00
Jared Quick
a5d049b346
Bump inspec to use the new train gem. (#3327)
Signed-off-by: Jared Quick <jquick@chef.io>
2018-08-23 17:04:04 -04:00
Jared Quick
53018e405b
Bump expeditor version. (#3298)
Signed-off-by: Jared Quick <jquick@chef.io>
2018-08-17 11:08:21 -04:00
Masayoshi Takahashi
5dffe9273e update README.md to fix travis and appveyor's badges. (#3244)
Obvious fix.
2018-07-23 10:45:22 +02:00
Jerry Aldrich
82f2340fb0 Add a CODE_OF_CONDUCT.md (#3212)
* Add a CODE_OF_CONDUCT.md
* Add links to the CODE_OF_CONDUCT.md
Also, remove some newlines/line endings.
* Replace broken waffle.io link
* Add Christoph/Dominik to Deciders role
* Add Jared Quick to Advocates
Adding his keybase since he doesn't have Twitter.

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-07-17 10:11:58 -04:00
David Schmitt
8f096ec667 Fix shell quoting in docker example (#3225)
This changes the use of `$@` to have double quotes, which avoids double
shell expansion of arguments to the function.

Example:
```
$ function tx { ls $@; }
$ tx a b
ls: cannot access 'a': No such file or directory
ls: cannot access 'b': No such file or directory
$ tx 'a b'
ls: cannot access 'a': No such file or directory
ls: cannot access 'b': No such file or directory
$ function tx { ls "$@"; }
$ tx a b
ls: cannot access 'a': No such file or directory
ls: cannot access 'b': No such file or directory
$ tx 'a b'
ls: cannot access 'a b': No such file or directory
$
```

Observe how in the corrected version the `'a b'` test case (a single
argument with a space inside) is handled correctly, while with the
original version the space is exposed to the shell, and the string
is broken up.

Signed-off-by: David Schmitt <david.schmitt@puppet.com>
2018-07-17 10:10:40 -04:00
Clinton Wolfe
94807401a7
trivial change for pipeline retry (#3121)
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
2018-06-07 18:48:06 -04:00
Jared Quick
eb237ac76e
Test new org builds. (#3087)
Signed-off-by: Jared Quick <jquick@chef.io>
2018-05-31 17:11:48 -04:00
Jared Quick
08c6e9c6c2
Update ruby required version. (#3070)
Signed-off-by: Jared Quick <jquick@chef.io>
2018-05-17 17:58:29 -04:00
David McCown
23967a2849 Refactors Terraform plan to break out steps (#2996)
This change should make it easier to work with a running environment.
You may now apply changes without doing a full teardown/rebuild any time
you make a change to the terraform plan.

Adds some documenation on how to use the Terraform tooling.

Adds AZURE_LOCATION to override the default region.

Signed-off-by: David McCown <dmccown@chef.io>
2018-04-29 14:00:12 -04:00
Jerry Aldrich
47ec76cb0a Update PowerShell requirement and add an asterisk (#2922)
Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-04-06 12:46:22 -04:00
eramoto
a687479e6c Fix typo in some docs (#2841)
Also includes fixes such as PostgreSQL, TCPMUX, and etc.

Signed-off-by: ERAMOTO Masaya <eramoto.masaya@jp.fujitsu.com>
2018-03-20 08:43:30 -04:00
Elijah Caine M. Voigt
514ffaa311 Fix mangled codeblock in README (#2830)
There were some missing back-ticks.

Obvious fix.
2018-03-15 15:42:17 -04:00
Jerry Aldrich
acf8a2eab5 Add g++ requirement to README.md (#2776)
The `g++` package is needed to install InSpec from RubyGems.

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-03-05 16:02:34 -05:00
Tommy Song
10ca3f44a0 docs: Add PS commands in Usage via Docker to README.md (#2778)
* Added commands support for Windows
* restructured the Usage via Docker block

Signed-off-by: Tommy Song <tommynsong@gmail.com>
2018-03-05 15:34:36 -05:00
Jerry Aldrich
c2dcb11f52 Move TESTING_AGAINST_AWS.md to test/aws (#2669)
* Move `TESTING_AGAINST_AWS.md` to `test/aws`
* Add link in README.md

Signed-off-by: Jerry Aldrich <jerryaldrichiii@gmail.com>
2018-03-02 09:11:56 -05:00
Franklin Webber
58958d5756 Updates README to use function instead of alias (#2679)
I really liked the inclusion of the alias for the docker run version
of installing inspec. The instructions tried to make it clear that
when you create the alias that it was for only your current directory
but it sounded more like your current working directory wherever you
were so I thought that it would be better to actually make that work.

By changing it to a function you now can delay the processing of the
$(pwd) subshell so that it will mount your current working directory
when you run it. This makes it really easy to use the InSpec CLI
and the installation this way is on par with the other ways.

Signed-off-by: Franklin Webber <franklin@chef.io>
2018-02-23 15:27:04 -05:00