diff options
| author | Tim Smith <tsmith@chef.io> | 2019-04-08 20:22:50 -0700 |
|---|---|---|
| committer | Tim Smith <tsmith@chef.io> | 2019-04-23 16:52:14 -0700 |
| commit | aa5560b99bbbf8b43ae20da511a5168a3d41ad0e (patch) | |
| tree | bffab8dd8f20366991ff25d74ea98ddecda9e7a6 /docs | |
| parent | 8ab44df64964ab961dc5ba95a6b1e57ac1ac7a08 (diff) | |
| download | chef-aa5560b99bbbf8b43ae20da511a5168a3d41ad0e.tar.gz | |
Add a readme for the dev docs and dep updating docs
Move the dep updating to it's own doc
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/dev/README.md | 9 | ||||
| -rw-r--r-- | docs/dev/updating_dependencies.md | 20 |
2 files changed, 29 insertions, 0 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md new file mode 100644 index 0000000000..afe8d0c1ac --- /dev/null +++ b/docs/dev/README.md @@ -0,0 +1,9 @@ +# Chef Infra Development Documentation + +This directory contains a collection of useful guides for both new and seasoned Chef contributors. There are many guides explaining how to build, test, and contribute to Chef Infra as well as documents describing how the many subsystems function. + +## Contents + +- [Building and Installing](./building_and_installing.md) +- [Updating Dependencies](./updating_dependencies.md) +- [Design Documents](./design_documents/)
\ No newline at end of file diff --git a/docs/dev/updating_dependencies.md b/docs/dev/updating_dependencies.md new file mode 100644 index 0000000000..f57cc76708 --- /dev/null +++ b/docs/dev/updating_dependencies.md @@ -0,0 +1,20 @@ +# Updating Dependencies + +If you want to change our constraints (change which packages and versions we accept in the chef), there are several places to do so: + +* [Gemfile](Gemfile) and [Gemfile.lock](Gemfile.lock): All gem version constraints (update with `bundle update`) +* [omnibus_overrides.rb](omnibus_overrides_rb): Pinned versions of omnibus packages. +* [omnibus/Gemfile](omnibus/Gemfile) and [omnibus/Gemfile.lock](omnibus/Gemfile.lock): Gems for the omnibus build system itself. + +In addition there are several places versions are pinned for CI tasks: + +* [kitchen-tests/Gemfile](kitchen-tests/Gemfile) and [kitchen-tests/Gemfile.lock](kitchen-tests/Gemfile.lock): Gems for test-kitchen tests (travis) + +In order to update everything run `rake dependencies`. Note that the [Gemfile.lock](Gemfile.lock) pins windows platforms and to fully regenerate the lockfile +you must use the following commands or run `rake dependencies:update_gemfile_lock`: + +```bash +bundle lock --update --add-platform ruby +bundle lock --update --add-platform x64-mingw32 +bundle lock --update --add-platform x86-mingw32 +```
\ No newline at end of file |