Skip to content

Conversation

@mkenigs
Copy link
Contributor

@mkenigs mkenigs commented Oct 27, 2025

A user asked for additional clarification of how locking of included environments works

A user asked for additional clarification of how locking of included
environments works
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 27, 2025
In order for changes to be pulled in, the included environment must have a lockfile corresponding to the latest changes to the manifest.
For example, suppose an environment `my-go-project` includes a `go-tools` environment.
If the `manifest.toml` for `go-tools` is modified without using `flox edit`, then `flox include upgrade` for `my-go-project` won't be able use the changes to the `go-tools` manifest.
Using `flox edit` for `go-tools` would re-lock the environment using the latest manifest, and then `flox include upgrade` for `my-go-project` could pull in the changes.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not 100% sold this is the right place to make the change. Can't decide if it's overexplaining the concept in the wrong place or not

@mkenigs mkenigs requested a review from zmitchell October 27, 2025 23:32
@github-actions
Copy link

Running this command will check each of the included environments and determine if there were changes to their manifests.
If the changes to the manifest have been built by the included environment, then the new manifest will be included.
Running this command will check each of the included environments and check if the environments have changed.
In order for changes to be pulled in, the included environment must have a lockfile corresponding to the latest changes to the manifest.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In order for changes to be pulled in, the included environment must have a lockfile corresponding to the latest changes to the manifest.
In order for changes to be pulled in, the manifest and lockfile of the the included environment must be in sync with one another (it's possible for them to get out of sync if you edit `manifest.toml` with your editor rather than `flox edit`).

Suggestion: this reads a little smoother to me

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants