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

Require project name in bolt-project.yaml instead of defaulting to the directory name #1871

Closed
lucywyman opened this issue Jun 3, 2020 · 0 comments · Fixed by #1913
Closed

Require project name in bolt-project.yaml instead of defaulting to the directory name #1871

lucywyman opened this issue Jun 3, 2020 · 0 comments · Fixed by #1913
Assignees
@nicklewis
Labels
Feature New features and improvements.
Milestone
Move bolt project...

Comments

@lucywyman
Copy link
Contributor

We currently attempt to infer a project name if it isn't set in bolt-project.yaml, which seems to cause more confusion than help. We should instead only load content from the bolt project if a name is set in bolt-project.yaml, and that content should be namespaced to the specified name. This should warn users with a bolt-project.yaml that doesn't have a name that project-level content won't be loaded.
@lucywyman lucywyman added the Feature New features and improvements. label Jun 3, 2020
@npwalker npwalker changed the title Project name should need to be set in bolt-project.yaml rather than inferred Require project name in bolt-project.yaml instead of defaulting to the directory name Jun 10, 2020
@nicklewis nicklewis self-assigned this Jun 17, 2020
nicklewis added a commit to nicklewis/bolt that referenced this issue Jun 18, 2020
@nicklewis
(puppetlabsGH-1871) Don't infer project name from directory name
86f4eff 
Previously, we would infer the project name from the directory name if
no name was specified in the bolt-project.yaml. This behavior proved to
be confusing for users, so we now require `name` to be specified
in bolt-project.yaml and otherwise will warn and not load project
content.

We previously recognized `<author>-<name>` directory names as valid
project names (using only the `<name>` portion) as that is a common
repo naming scheme for modules. As the project name must now be
specified explicitly, we instead require it be simply the name portion.
nicklewis added a commit to nicklewis/bolt that referenced this issue Jun 18, 2020
@nicklewis
(puppetlabsGH-1871) Don't infer project name from directory name
e842485 
Previously, we would infer the project name from the directory name if
no name was specified in the bolt-project.yaml. This behavior proved to
be confusing for users, so we now require `name` to be specified
in bolt-project.yaml and otherwise will warn and not load project
content.

We previously recognized `<author>-<name>` directory names as valid
project names (using only the `<name>` portion) as that is a common
repo naming scheme for modules. As the project name must now be
specified explicitly, we instead require it be simply the name portion.

!deprecation

  * **Project names must be explicitly specified** ([puppetlabs#1871](puppetlabs#1871))

    Proejct names must now be specified in `bolt-project.yaml` in order
    for project-level content to be loaded, rather than the name being
    inferred by the name of the project directory.
@nicklewis nicklewis mentioned this issue Jun 18, 2020
Merged
nicklewis added a commit to nicklewis/bolt that referenced this issue Jun 18, 2020
@nicklewis
(puppetlabsGH-1871) Don't infer project name from directory name
01b8e71 
Previously, we would infer the project name from the directory name if
no name was specified in the bolt-project.yaml. This behavior proved to
be confusing for users, so we now require `name` to be specified
in bolt-project.yaml and otherwise will warn and not load project
content.

We previously recognized `<author>-<name>` directory names as valid
project names (using only the `<name>` portion) as that is a common
repo naming scheme for modules. As the project name must now be
specified explicitly, we instead require it be simply the name portion.

!deprecation

  * **Project names must be explicitly specified** ([puppetlabs#1871](puppetlabs#1871))

    Proejct names must now be specified in `bolt-project.yaml` in order
    for project-level content to be loaded, rather than the name being
    inferred by the name of the project directory.
nicklewis added a commit to nicklewis/bolt that referenced this issue Jun 18, 2020
@nicklewis
(puppetlabsGH-1871) Don't infer project name from directory name
5697f54 
Previously, we would infer the project name from the directory name if
no name was specified in the bolt-project.yaml. This behavior proved to
be confusing for users, so we now require `name` to be specified
in bolt-project.yaml and otherwise will warn and not load project
content.

We previously recognized `<author>-<name>` directory names as valid
project names (using only the `<name>` portion) as that is a common
repo naming scheme for modules. As the project name must now be
specified explicitly, we instead require it be simply the name portion.

!deprecation

  * **Project names must be explicitly specified** ([puppetlabs#1871](puppetlabs#1871))

    Proejct names must now be specified in `bolt-project.yaml` in order
    for project-level content to be loaded, rather than the name being
    inferred by the name of the project directory.
nicklewis added a commit to nicklewis/bolt that referenced this issue Jun 22, 2020
@nicklewis
(puppetlabsGH-1871) Don't infer project name from directory name
a540cc3 
Previously, we would infer the project name from the directory name if
no name was specified in the bolt-project.yaml. This behavior proved to
be confusing for users, so we now require `name` to be specified
in bolt-project.yaml and otherwise will warn and not load project
content.

We previously recognized `<author>-<name>` directory names as valid
project names (using only the `<name>` portion) as that is a common
repo naming scheme for modules. As the project name must now be
specified explicitly, we instead require it be simply the name portion.

!deprecation

  * **Project names must be explicitly specified** ([puppetlabs#1871](puppetlabs#1871))

    Proejct names must now be specified in `bolt-project.yaml` in order
    for project-level content to be loaded, rather than the name being
    inferred by the name of the project directory.
nicklewis added a commit to nicklewis/bolt that referenced this issue Jun 22, 2020
@nicklewis
(puppetlabsGH-1871) Don't infer project name from directory name
c0a7dc7 
Previously, we would infer the project name from the directory name if
no name was specified in the bolt-project.yaml. This behavior proved to
be confusing for users, so we now require `name` to be specified
in bolt-project.yaml and otherwise will warn and not load project
content.

We previously recognized `<author>-<name>` directory names as valid
project names (using only the `<name>` portion) as that is a common
repo naming scheme for modules. As the project name must now be
specified explicitly, we instead require it be simply the name portion.

!deprecation

  * **Project names must be explicitly specified** ([puppetlabs#1871](puppetlabs#1871))

    Proejct names must now be specified in `bolt-project.yaml` in order
    for project-level content to be loaded, rather than the name being
    inferred by the name of the project directory.
nicklewis added a commit to nicklewis/bolt that referenced this issue Jun 22, 2020
@nicklewis
(puppetlabsGH-1871) Don't infer project name from directory name
8a73fb8 
Previously, we would infer the project name from the directory name if
no name was specified in the bolt-project.yaml. This behavior proved to
be confusing for users, so we now require `name` to be specified
in bolt-project.yaml and otherwise will warn and not load project
content.

We previously recognized `<author>-<name>` directory names as valid
project names (using only the `<name>` portion) as that is a common
repo naming scheme for modules. As the project name must now be
specified explicitly, we instead require it be simply the name portion.

!deprecation

  * **Project names must be explicitly specified** ([puppetlabs#1871](puppetlabs#1871))

    Proejct names must now be specified in `bolt-project.yaml` in order
    for project-level content to be loaded, rather than the name being
    inferred by the name of the project directory.
@beechtom beechtom linked a pull request Jun 23, 2020 that will close this issue
(GH-1871) Don't infer project name from directory name #1913
Merged
lucywyman added a commit that referenced this issue Jun 24, 2020
@lucywyman
Merge pull request #1913 from nicklewis/GH-1871-require-project-name
64eda1b 
(GH-1871) Don't infer project name from directory name
jpogran pushed a commit to jpogran/bolt that referenced this issue Sep 1, 2020
@nicklewis @jpogran
(puppetlabsGH-1871) Don't infer project name from directory name
aff04eb 
Previously, we would infer the project name from the directory name if
no name was specified in the bolt-project.yaml. This behavior proved to
be confusing for users, so we now require `name` to be specified
in bolt-project.yaml and otherwise will warn and not load project
content.

We previously recognized `<author>-<name>` directory names as valid
project names (using only the `<name>` portion) as that is a common
repo naming scheme for modules. As the project name must now be
specified explicitly, we instead require it be simply the name portion.

!deprecation

  * **Project names must be explicitly specified** ([puppetlabs#1871](puppetlabs#1871))

    Proejct names must now be specified in `bolt-project.yaml` in order
    for project-level content to be loaded, rather than the name being
    inferred by the name of the project directory.
@pcarlisle pcarlisle mentioned this issue Sep 25, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nicklewis nicklewis

Labels
Feature New features and improvements.
Projects
None yet
Milestone
Move bolt projects out of experimental
Development

Successfully merging a pull request may close this issue.

(GH-1871) Don't infer project name from directory name nicklewis/bolt
3 participants
@nicklewis @npwalker @lucywyman