Repository navigation
fix: honour changelog --max-releases for projects without pyproject.toml - #468
Merged
Merged
Conversation
Reading the project metadata reloaded `great-docs.yml` from disk and replaced the configuration held in memory. With a `pyproject.toml` the metadata is cached after the first read, which happens while `GreatDocs` is constructed, so the reload had no effect. Without one, as in Go and Rust projects, every read reloaded the file and discarded any value set in memory since. `great-docs changelog --max-releases N` sets N in memory and then looks up the GitHub repository, which reads the metadata. For a project without `pyproject.toml` the value was lost and the command fetched the configured number of releases, 50 by default. Configuration changed in memory is now kept, so `--max-releases` is honoured for projects without `pyproject.toml`. Nothing else relied on the reload: `great-docs init` reloads the configuration itself after writing the file.
📚 Preview this PR's docs locallyFetch the just-built site and open it in your browser: # this exact build
great-docs preview --run 40878448871
# or always the latest build for this PR
great-docs preview --pr 468Auth & tips
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR stops the project-metadata read from reloading
great-docs.ymland replacing the configuration held in memory. With apyproject.tomlthe metadata was cached during construction, so the reload never mattered. Without one, as in Go and Rust projects, every read discarded values set in memory:great-docs changelog --max-releases 3fetched the configured number of releases, 50 by default.