Skip to content

Commit

Permalink
#163: Add note about generating ignored files
Browse files Browse the repository at this point in the history
  • Loading branch information
mtkennerly committed Jan 3, 2024
1 parent 86e4ed0 commit c2b3c97
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,10 @@ In your pyproject.toml file, you may configure the following options:
Each table key is a path to a specific file (no globs) relative to the project root.
Each nested table supports these fields:

If you use these options to generate a file that's ignored by your VCS,
but you also want the generated file to be included in the output of `poetry build`,
then you'll need to name the file explicitly in your `tool.poetry.include` config.

* `persistent-substitution` (boolean, optional):
If true, then do not revert any substitutions applied to this file.
This is primarily useful for editable installs, if you need the version to remain in a file ignored by your VCS.
Expand Down

0 comments on commit c2b3c97

Please sign in to comment.