Skip to content

Warn in the documentation that spring.profiles.group can only be used in non-profile-specific documents #40918

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.

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

Conversation

vsanna
Copy link
Contributor

@vsanna vsanna commented May 28, 2024

Why

Currently, the official reference says that spring.profiles.active, spring.profiles.default and spring.profiles.include can only be used in non profile-specific.
However, after some investigation, I believe spring.profiles.group also must be in non-profile-specific configuration files.

Lacking the warning made me confused a little bit. So I suppose it would be great if we have the similar section for spring.profiles.group.

What

  • I've added a warning section, that is similar to one used for spring.profiles.include, for spring.profiles.group
  • I tweaked a little bit to align with the terminology "profile-specific" used in a headline.

@pivotal-cla
Copy link

@vsanna Please sign the Contributor License Agreement!

Click here to manually synchronize the status of this Pull Request.

See the FAQ for frequently asked questions.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label May 28, 2024
@pivotal-cla
Copy link

@vsanna Thank you for signing the Contributor License Agreement!

@vsanna vsanna changed the title chore: add the same warning for spring.profiles.group as well as spring.profiles.include [proposal] chore: add the same warning for spring.profiles.group as well as spring.profiles.include May 28, 2024
@@ -32,7 +32,7 @@ spring:
default: "none"
----

`spring.profiles.active` and `spring.profiles.default` can only be used in non-profile specific documents.
`spring.profiles.active` and `spring.profiles.default` can only be used in non-profile-specific documents.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this is a trivial point, so I don't have strong preferense or opinion. I will revert if I should

@wilkinsona wilkinsona changed the title [proposal] chore: add the same warning for spring.profiles.group as well as spring.profiles.include Warn in the documentation that spring.profiles.group can only be used in non-profile-specific documents May 28, 2024
@wilkinsona wilkinsona added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels May 28, 2024
@wilkinsona wilkinsona added this to the 3.2.x milestone May 28, 2024
@mhalbritter mhalbritter self-assigned this May 29, 2024
mhalbritter pushed a commit that referenced this pull request May 29, 2024
@mhalbritter
Copy link
Contributor

Thank you very much and congratulations on your first contribution 🎉!

@mhalbritter mhalbritter modified the milestones: 3.2.x, 3.2.7 May 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants