Skip to content

Commit

Permalink
Add changelog entry
Browse files Browse the repository at this point in the history
  • Loading branch information
mitsuhiko committed Jan 20, 2024
1 parent d8ef1f7 commit 9c3cfa2
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ _Unreleased_

- Detect when a virtualenv relocates and automatically re-create it on sync. #538

- Added `lock --with-sources`, `sync --with-sources` and the new `rye.tool.lock-with-sources`
config. Passing this will ensure that source references are included in the
lock files. #540

<!-- released start -->

## 0.17.0
Expand Down
5 changes: 4 additions & 1 deletion docs/guide/sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,13 @@ rye lock Flask --pre

### `--with-sources`

+++ 0.18.0

By default (unless the `tool.rye.lock-with-sources` config key is set to `true` in the
`pyproject.toml`) lock files are not generated with source references. This means that
if custom sources are used the lock file cannot be installed via `pip` unless also
`--find-links` and other parameters are manually passed.
`--find-links` and other parameters are manually passed. This can be particularly useful
when the lock file is used for docker image builds.

When this flag is passed then the lock file is generated with references to `--index-url`,
`--extra-index-url` or `--find-links`.
Expand Down

0 comments on commit 9c3cfa2

Please sign in to comment.