Skip to content
This repository has been archived by the owner on May 31, 2024. It is now read-only.

refactor: remove redundant YAML packages #387

Merged
merged 1 commit into from
Feb 14, 2023
Merged

refactor: remove redundant YAML packages #387

merged 1 commit into from
Feb 14, 2023

Conversation

Juneezee
Copy link
Contributor

TL;DR

Remove redundant YAML packages: github.com/ghodss/yaml and gopkg.in/yaml.v2

Type

  • Bug Fix
  • Feature
  • Plugin

Are all requirements met?

  • Code completed
  • Smoke tested
  • Unit tests added
  • Code documentation added
  • Any pending items have an associated Issue

Complete description

Currently four YAML packages are used:

  1. github.com/ghodss/yaml
  2. gopkg.in/yaml.v2
  3. gopkg.in/yaml.v3
  4. sigs.k8s.io/yaml

We can keep only two of them:

  1. gopkg.in/yaml.v3
  2. sigs.k8s.io/yaml

The package github.com/ghodss/yaml is no longer actively maintained. See discussion in ghodss/yaml#80 and ghodss/yaml#75. sigs.k8s.io/yaml is a permanent fork of ghodss/yaml and is actively maintained by Kubernetes SIG, also widely used in K8s projects.

We are only using gopkg.in/yaml.v2 in cmd/config/subcommand/project/project_config.go. Switching to gopkg.in/yaml.v3 doesn't introduce breaking change here.

Tracking Issue

Follow-up issue

NA

At the time of making this commit, the package `github.com/ghodss/yaml`
is no longer actively maintained. `sigs.k8s.io/yaml` is a permanent fork
of `ghodss/yaml` and is actively maintained by Kubernetes SIG.

Signed-off-by: Eng Zer Jun <[email protected]>
@codecov
Copy link

codecov bot commented Feb 14, 2023

Codecov Report

Merging #387 (18987e4) into master (1b2221f) will increase coverage by 0.77%.
The diff coverage is n/a.

❗ Current head 18987e4 differs from pull request most recent head 65cfc86. Consider uploading reports for the commit 65cfc86 to get more accurate results

@@            Coverage Diff             @@
##           master     #387      +/-   ##
==========================================
+ Coverage   66.54%   67.32%   +0.77%     
==========================================
  Files         145      145              
  Lines        6265     5230    -1035     
==========================================
- Hits         4169     3521     -648     
+ Misses       1816     1429     -387     
  Partials      280      280              
Flag Coverage Δ
unittests ?

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
cmd/config/subcommand/project/project_config.go 80.64% <ø> (+3.14%) ⬆️
pkg/printer/printer.go 74.21% <ø> (+1.62%) ⬆️
cmd/get/matchable_workflow_execution_config.go 37.20% <0.00%> (-8.95%) ⬇️
cmd/delete/matchable_attribute_util.go 54.16% <0.00%> (-4.46%) ⬇️
cmd/update/matchable_attribute_util.go 56.00% <0.00%> (-4.00%) ⬇️
cmd/core/cmd_ctx.go 58.82% <0.00%> (-2.29%) ⬇️
cmd/register/examples.go 93.75% <0.00%> (-1.71%) ⬇️
cmd/get/matchable_attribute_util.go 73.68% <0.00%> (-1.32%) ⬇️
cmd/root.go 47.54% <0.00%> (-1.27%) ⬇️
cmd/update/named_entity.go 89.28% <0.00%> (-1.04%) ⬇️
... and 126 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@eapolinario eapolinario merged commit 5aefa07 into flyteorg:master Feb 14, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants