Skip to content

Refresh README: fix stale versions, links, and Travis references #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tas50 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Refresh README: fix stale versions, links, and Travis references #35

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 7 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# ChefSpec

[![Gem Version](https://badge.fury.io/rb/chefspec.svg)](https://badge.fury.io/rb/chefspec)
[![CI](https://github.com/chefspec/chefspec/actions/workflows/ci.yml/badge.svg)](https://github.com/chefspec/chefspec/actions/workflows/ci.yml)
[![CI](https://github.com/chef/chefspec/actions/workflows/ci.yml/badge.svg)](https://github.com/chef/chefspec/actions/workflows/ci.yml)

ChefSpec is a unit testing framework for testing Chef cookbooks. ChefSpec makes it easy to write examples and get fast feedback on cookbook changes without the need for virtual machines or cloud servers.

Expand All @@ -12,14 +12,12 @@ ChefSpec runs your cookbooks locally while skipping making actual changes. This

## Important Notes

- **ChefSpec requires Ruby 2.5 or later and Chef 15 or later!**
- **ChefSpec requires Ruby 3.1 or later and Chef 17 or later!**
- **This documentation corresponds to the main branch, which may be unreleased. Please check the README of the latest git tag or the gem's source for your version's documentation!**

**ChefSpec aims to maintain compatibility with at least the two most recent minor versions of Chef.** If you are running an older version of Chef it may work, or you will need to run an older version of ChefSpec.

As a general rule, if it is tested in the Travis CI matrix, it is a supported version.

## Quick Start
As a general rule, if it is tested in the [GitHub Actions](https://github.com/chef/chefspec/actions) CI matrix, it is a supported version.

## When To Use ChefSpec?

Expand Down Expand Up @@ -581,7 +579,7 @@ end
All the ruby methods off of the File, Dir and FileUtils classes along with any other global class methods that the
client might use, should follow a similar pattern for stubbing.

Check out the [RSpec Mocks documentation](https://relishapp.com/rspec/rspec-mocks/docs)
Check out the [RSpec Mocks documentation](https://rspec.info/documentation/)
for more information about setting up Ruby method stubs.

## Development
Expand Down Expand Up @@ -609,13 +607,13 @@ for more information about setting up Ruby method stubs.

8. Open a Pull Request

ChefSpec is on [Travis CI][travis] which tests against multiple Chef and Ruby versions.
ChefSpec is tested via [GitHub Actions](https://github.com/chef/chefspec/actions) against multiple Ruby versions.

If you are contributing, please see the [Contributing Guidelines](https://github.com/chefspec/chefspec/blob/main/CONTRIBUTING.md) for more information.
If you are contributing, please see the [Contributing Guidelines](https://github.com/chef/chefspec/blob/main/CONTRIBUTING.md) for more information.

## License

MIT - see the accompanying [LICENSE](https://github.com/chefspec/chefspec/blob/main/LICENSE) file for details.
MIT - see the accompanying [LICENSE](https://github.com/chef/chefspec/blob/main/LICENSE) file for details.

# Copyright
See [COPYRIGHT.md](./COPYRIGHT.md).
Loading