cloudfoundry / cloudfoundry/cli

Replacement of yaml parser

Open
#3,694 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
1.9k
Forks
990
Avg merge
1d 7h
Merged PRs (30d)
8

Description

Hello,

I have recently worked over issue related with our cf cli plugin and I have identified we use gopkg.in/yaml module to parse yaml descriptors. This module is quite outdated and public github repo - https://github.com/go-yaml/yaml is already archived.

The same archived project is still used by cf cli - https://github.com/cloudfoundry/cli/blob/main/go.mod#L47C2-L47C18 and should be migrated to maintained library.

Suggested replacement could be this project - https://github.com/yaml/go-yaml which is fork of the original project but It could be chosen another yaml parser library.

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 with go.mod, especially the gopkg.in/yaml dependency, then locate its usages in the cf CLI and compare them with the maintained yaml/go-yaml fork or another parser. Confirm the chosen replacement supports the existing YAML descriptors and run the CLI's existing checks to verify parsing remains correct; done means the archived dependency is no longer used.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, yaml
Domain
cli, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.