Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

cmd/cue: help texts still mention enabling the modules experiment #3151

Closed
mvdan opened this issue May 16, 2024 · 2 comments
Closed

cmd/cue: help texts still mention enabling the modules experiment #3151

mvdan opened this issue May 16, 2024 · 2 comments
Assignees
@myitcv
Labels
modules Issues related to CUE modules and the experimental implementation NeedsFix

Comments

@mvdan
Copy link
Member

mvdan commented May 16, 2024

cue help modules still says:

NOTE: modules support is current experimental. To enable the
experiment, you must enable the modules experiment by exporting this
environment variable:

	CUE_EXPERIMENT=modules

and others like cue help mod tidy also say:

Note: you must enable the modules experiment with:
	export CUE_EXPERIMENT=modules
for this command to work.

This is out of date. These texts should be removed, or at least amended, for the first release candidate.
@mvdan mvdan added NeedsFix modules Issues related to CUE modules and the experimental implementation labels May 16, 2024
@mvdan
Copy link
Member Author

mvdan commented May 16, 2024

Note #3135 which is the website counterpart, as it has other modules content like tutorials with similar issues.

@mvdan
Copy link
Member Author

mvdan commented May 16, 2024

I also see that cue/load has the same issue:

	// When nil, if the modules experiment is enabled
	// (CUE_EXPERIMENT=modules), [modconfig.NewRegistry]
	// will be used to create a registry instance using the
	// usual cmd/cue conventions for environment variables
	// (but see the Env field below).

cueckoo pushed a commit to cue-lang/cuelang.org that referenced this issue May 20, 2024
@jpluscplusm
docs/*: remove mention of the modules experiment
402c5b2 
This change removes (almost) all mention of CUE_EXPERIMENT=modules from
the site.

Now that the modules proposal has been accepted (cue-lang/cue#2939) and
the latest prerelease reflects that through the new modules behaviour
being its default, we don't need to mention the experiment on pages that
explicitly use that prerelease.

docs/tutorial/using-modules-with-go-api/ is updated to rely on
v0.9.0-alpha.5 (instead of v0.8.x) in order to exercise the prereleases'
module-related code, and to allow us to remove the CUE_EXPERIMENT
mention from this page.

Some pages under docs/reference/cli/ still contain the phrase, pending
the text's removal from the upstream source, tracked in
cue-lang/cue#3151.

For cue-lang/docs-and-content#147

Preview-Path: /docs/reference/modules/
Preview-Path: /docs/tutorial/using-modules-with-go-api/
Preview-Path: /docs/tutorial/publishing-modules-to-the-central-registry/
Preview-Path: /docs/tutorial/working-with-a-custom-module-registry/
Preview-Path: /docs/tutorial/working-with-the-central-registry/
Signed-off-by: Jonathan Matthews <github@hello.jonathanmatthews.com>
Change-Id: I8cbe8693dfa28388f82be0905ee098b034e8da84
cueckoo pushed a commit to cue-lang/cuelang.org-trybot that referenced this issue May 20, 2024
@jpluscplusm @cueckoo
docs/*: remove mention of the modules experiment
e320b71 
This change removes (almost) all mention of CUE_EXPERIMENT=modules from
the site.

Now that the modules proposal has been accepted (cue-lang/cue#2939) and
the latest prerelease reflects that through the new modules behaviour
being its default, we don't need to mention the experiment on pages that
explicitly use that prerelease.

docs/tutorial/using-modules-with-go-api/ is updated to rely on
v0.9.0-alpha.5 (instead of v0.8.x) in order to exercise the prereleases'
module-related code, and to allow us to remove the CUE_EXPERIMENT
mention from this page.

Some pages under docs/reference/cli/ still contain the phrase, pending
the text's removal from the upstream source, tracked in
cue-lang/cue#3151.

For cue-lang/docs-and-content#147

Preview-Path: /docs/reference/modules/
Preview-Path: /docs/tutorial/using-modules-with-go-api/
Preview-Path: /docs/tutorial/publishing-modules-to-the-central-registry/
Preview-Path: /docs/tutorial/working-with-a-custom-module-registry/
Preview-Path: /docs/tutorial/working-with-the-central-registry/
Signed-off-by: Jonathan Matthews <github@hello.jonathanmatthews.com>
Change-Id: I8cbe8693dfa28388f82be0905ee098b034e8da84
Dispatch-Trailer: {"type":"trybot","CL":1194896,"patchset":4,"ref":"refs/changes/96/1194896/4","targetBranch":"master"}
@jpluscplusm jpluscplusm mentioned this issue May 22, 2024
Closed
cueckoo pushed a commit to cue-lang/cuelang.org that referenced this issue May 22, 2024
@jpluscplusm
docs/*: remove mention of the modules experiment
ab960c2 
This change removes (almost) all mention of CUE_EXPERIMENT=modules from
the site.

Now that the modules proposal has been accepted (cue-lang/cue#2939) and
the latest prerelease reflects that through the new modules behaviour
being its default, we don't need to mention the experiment on pages that
explicitly use that prerelease.

docs/tutorial/using-modules-with-go-api/ is updated to rely on
v0.9.0-alpha.5 (instead of v0.8.x) in order to exercise the prereleases'
module-related code, and to allow us to remove the CUE_EXPERIMENT
mention from this page.

Some pages under docs/reference/cli/ still contain the phrase, pending
the text's removal from the upstream source, tracked in
cue-lang/cue#3151.

For cue-lang/docs-and-content#147

Preview-Path: /docs/reference/modules/
Preview-Path: /docs/tutorial/using-modules-with-go-api/
Preview-Path: /docs/tutorial/publishing-modules-to-the-central-registry/
Preview-Path: /docs/tutorial/working-with-a-custom-module-registry/
Preview-Path: /docs/tutorial/working-with-the-central-registry/
Signed-off-by: Jonathan Matthews <github@hello.jonathanmatthews.com>
Change-Id: I8cbe8693dfa28388f82be0905ee098b034e8da84
Reviewed-on: https://review.gerrithub.io/c/cue-lang/cuelang.org/+/1194896
TryBot-Result: CUEcueckoo <cueckoo@cuelang.org>
Reviewed-by: Paul Jolly <paul@myitcv.io>
@jpluscplusm jpluscplusm mentioned this issue May 22, 2024
Open
@myitcv myitcv self-assigned this May 30, 2024
cueckoo pushed a commit that referenced this issue May 30, 2024
@myitcv
cmd/cue: remove 'experimental' guard on modules (commands)
e4e21c1 
As part of https://cuelang.org/issue/2939 we recently accepted the
modules proposal.

As a follow up to that decision, we now remove the 'experimental'
warning language around all modules commands.

The one exception is 'cue login': it remains experimental as the Central
Registry (https://registry.cue.works) is itself still in
alpha/experimental phase.

Fixes #3151.

Signed-off-by: Paul Jolly <paul@myitcv.io>
Change-Id: I4d98fd98d7bff8348014d38cc99d98216facac57
cueckoo pushed a commit that referenced this issue May 30, 2024
@myitcv
cmd/cue: remove 'experimental' guard on modules (commands)
ee26a1b 
As part of https://cuelang.org/issue/2939 we recently accepted the
modules proposal.

As a follow up to that decision, we now remove the 'experimental'
warning language around all modules commands.

The one exception is 'cue login': it remains experimental as the Central
Registry (https://registry.cue.works) is itself still in
alpha/experimental phase.

Fixes #3151.

Signed-off-by: Paul Jolly <paul@myitcv.io>
Change-Id: I4d98fd98d7bff8348014d38cc99d98216facac57
cueckoo pushed a commit that referenced this issue May 30, 2024
@myitcv
cmd/cue: remove 'experimental' guard on modules (commands)
b779c3c 
As part of https://cuelang.org/issue/2939 we recently accepted the
modules proposal.

As a follow up to that decision, we now remove the 'experimental'
warning language around all modules commands.

The one exception is 'cue login': it remains experimental as the Central
Registry (https://registry.cue.works) is itself still in
alpha/experimental phase.

Note that despite accepting the modules proposal, the modules commands
themselves are not yet considered fully stable. Hence we leave the
following warning at the bottom of the help text for each command:

> Note that this command is not yet stable and may be changed.

With the modules "experiment" now defaulted to "on", we will gain more
confidence about the extent to which those commands are indeed stable
throughout the course of v0.9.0.

Fixes #3151.

Signed-off-by: Paul Jolly <paul@myitcv.io>
Change-Id: I4d98fd98d7bff8348014d38cc99d98216facac57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@myitcv myitcv

Labels
modules Issues related to CUE modules and the experimental implementation NeedsFix
Projects
Modules Roadmap
Status: Done
Release v0.9
Status: v0.9.0-rc.1
Milestone
No milestone
Development

No branches or pull requests
3 participants
@rogpeppe @myitcv @mvdan