microsoft / microsoft/go

Clearly separate go-images generated files from auto-update configuration data

Open
#281 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area-Docker
Dominant language
Go
Stars
431
Forks
44
Avg merge
21h 18m
Merged PRs (30d)
30

Description

Right now in go-images, these two files are key:

  • src/microsoft/versions.json
    • Configuration: Manually updated with which versions to receive updates from and which versions are preferred for "floating" tags.
    • Generated: The version and arches (artifact) data is automatically updated inside this file.
  • manifest.json
    • Configuration: The repo name is configured manually in this file.
    • Generated: The list of images, Dockerfiles, tags is generated.

Keeping track of which part of these files is edited vs. auto-updated requires looking at the code, or docs. I think we should have a third file that contains all configuration, and make the two existing files 100% generated. This would make it easier to add a new image, OS/arch, or branch.

  • Related: #195

Contributor guide

No contributing guide indexed for this repository

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 comparing src/microsoft/versions.json and manifest.json, then read the related issue #195. Define the separate configuration file and identify how the existing files are generated; the work is done when configuration and generated data are clearly separated in the go-images workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
build-system
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.