summaryrefslogtreecommitdiff
path: root/docs/dev/updating_dependencies.md
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2019-04-08 20:22:50 -0700
committerTim Smith <tsmith@chef.io>2019-04-23 16:52:14 -0700
commitaa5560b99bbbf8b43ae20da511a5168a3d41ad0e (patch)
treebffab8dd8f20366991ff25d74ea98ddecda9e7a6 /docs/dev/updating_dependencies.md
parent8ab44df64964ab961dc5ba95a6b1e57ac1ac7a08 (diff)
downloadchef-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/dev/updating_dependencies.md')
-rw-r--r--docs/dev/updating_dependencies.md20
1 files changed, 20 insertions, 0 deletions
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