spring-cloud / spring-cloud/spring-cloud-config

Version and State Information In Composite Environments

Open
#720 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

closable enhancement
Dominant language
Java
Stars
2k
Forks
1.3k
Avg merge
2d 59m
Merged PRs (30d)
16

Description

Today an Environment includes version and state properties but these properties don't make to much sense when using a composite environment. It might be better to move these properties to the PropertySource level.

Current:

{
   "name":"configurations",
   "profiles":[
      "default"
   ],
   "label":null,
   "version":"1e70e2f38b156fe222403262abe52de8eddbcb20",
   "state":null,
   "propertySources":[
      {
         "name":"https://github.com/ryanjbaxter/config-repo/application.yml",
         "source":{
            "info.description":"Ryans Spring Cloud Samples",
            "info.url":"https://github.com/spring-cloud-samples",
            "eureka.client.serviceUrl.defaultZone":"http://localhost:8761/eureka/",
            "foo":"from-default"
         }
      }
   ]
}

Proposal:

{
   "name":"configurations",
   "profiles":[
      "default"
   ],
   "label":null,
   "propertySources":[
      {
         "name":"https://github.com/ryanjbaxter/config-repo/application.yml",
        "version":"1e70e2f38b156fe222403262abe52de8eddbcb20",
        "state":null,
         "source":{
            "info.description":"Ryans Spring Cloud Samples",
            "info.url":"https://github.com/spring-cloud-samples",
            "eureka.client.serviceUrl.defaultZone":"http://localhost:8761/eureka/",
            "foo":"from-default"
         }
      }
   ]
}

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how the Environment and PropertySource representations produce the current JSON, then compare that output with the proposed composite-environment shape. Determine how version and state should be represented for each property source and identify the relevant tests or entry points. Done means the response consistently exposes those fields at the PropertySource level without retaining the inappropriate environment-level values.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, java, spring, spring-boot
Domain
backend, cloud
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.