From fb3a1f2d4cb0638633f6155bd8dfc0e7e153f911 Mon Sep 17 00:00:00 2001 From: Vassil Kovatchev Date: Sun, 10 Mar 2024 16:30:35 -0400 Subject: [PATCH] Remove .v3 from name --- .github/workflows/go.yaml | 6 +- README.md | 149 +------------------------------------- decode_test.go | 2 +- encode_test.go | 2 +- example_embedded_test.go | 2 +- go.mod | 2 +- limit_test.go | 2 +- node_test.go | 2 +- 8 files changed, 10 insertions(+), 157 deletions(-) diff --git a/.github/workflows/go.yaml b/.github/workflows/go.yaml index 980a3350..16923ec8 100644 --- a/.github/workflows/go.yaml +++ b/.github/workflows/go.yaml @@ -28,7 +28,7 @@ jobs: - name: Check out code into the Go module directory uses: actions/checkout@v2 with: - path: ${{ github.workspace }}/go/src/github.com/zillow/go-yaml.v3 + path: ${{ github.workspace }}/go/src/github.com/zillow/go-yaml - name: Set up Go ${{ matrix.go }} if: matrix.go != 'tip' uses: actions/setup-go@v2 @@ -56,6 +56,6 @@ jobs: echo "$GOROOT/bin" >> $GITHUB_PATH - run: go version - run: go get -t ./... - working-directory: ${{ github.workspace }}/go/src/github.com/zillow/go-yaml.v3 + working-directory: ${{ github.workspace }}/go/src/github.com/zillow/go-yaml - run: go test . - working-directory: ${{ github.workspace }}/go/src/github.com/zillow/go-yaml.v3 + working-directory: ${{ github.workspace }}/go/src/github.com/zillow/go-yaml diff --git a/README.md b/README.md index fc7cd97a..5996ab20 100644 --- a/README.md +++ b/README.md @@ -1,150 +1,3 @@ # YAML support for the Go language -Introduction ------------- - -The yaml package enables Go programs to comfortably encode and decode YAML -values. It was developed within [Canonical](https://www.canonical.com) as -part of the [juju](https://juju.ubuntu.com) project, and is based on a -pure Go port of the well-known [libyaml](http://pyyaml.org/wiki/LibYAML) -C library to parse and generate YAML data quickly and reliably. - -Compatibility -------------- - -The yaml package supports most of YAML 1.2, but preserves some behavior -from 1.1 for backwards compatibility. - -Specifically, as of v3 of the yaml package: - - - YAML 1.1 bools (_yes/no, on/off_) are supported as long as they are being - decoded into a typed bool value. Otherwise they behave as a string. Booleans - in YAML 1.2 are _true/false_ only. - - Octals encode and decode as _0777_ per YAML 1.1, rather than _0o777_ - as specified in YAML 1.2, because most parsers still use the old format. - Octals in the _0o777_ format are supported though, so new files work. - - Does not support base-60 floats. These are gone from YAML 1.2, and were - actually never supported by this package as it's clearly a poor choice. - -and offers backwards -compatibility with YAML 1.1 in some cases. -1.2, including support for -anchors, tags, map merging, etc. Multi-document unmarshalling is not yet -implemented, and base-60 floats from YAML 1.1 are purposefully not -supported since they're a poor design and are gone in YAML 1.2. - -Installation and usage ----------------------- - -The import path for the package is *github.com/zillow/go-yaml.v3*. - -To install it, run: - - go get github.com/zillow/go-yaml.v3 - -API documentation ------------------ - -If opened in a browser, the import path itself leads to the API documentation: - - - [https://github.com/zillow/go-yaml.v3](https://github.com/zillow/go-yaml.v3) - -API stability -------------- - -The package API for yaml v3 will remain stable as described in [gopkg.in](https://gopkg.in). - - -License -------- - -The yaml package is licensed under the MIT and Apache License 2.0 licenses. -Please see the LICENSE file for details. - - -Example -------- - -```Go -package main - -import ( - "fmt" - "log" - - "github.com/zillow/go-yaml.v3" -) - -var data = ` -a: Easy! -b: - c: 2 - d: [3, 4] -` - -// Note: struct fields must be public in order for unmarshal to -// correctly populate the data. -type T struct { - A string - B struct { - RenamedC int `yaml:"c"` - D []int `yaml:",flow"` - } -} - -func main() { - t := T{} - - err := yaml.Unmarshal([]byte(data), &t) - if err != nil { - log.Fatalf("error: %v", err) - } - fmt.Printf("--- t:\n%v\n\n", t) - - d, err := yaml.Marshal(&t) - if err != nil { - log.Fatalf("error: %v", err) - } - fmt.Printf("--- t dump:\n%s\n\n", string(d)) - - m := make(map[interface{}]interface{}) - - err = yaml.Unmarshal([]byte(data), &m) - if err != nil { - log.Fatalf("error: %v", err) - } - fmt.Printf("--- m:\n%v\n\n", m) - - d, err = yaml.Marshal(&m) - if err != nil { - log.Fatalf("error: %v", err) - } - fmt.Printf("--- m dump:\n%s\n\n", string(d)) -} -``` - -This example will generate the following output: - -``` ---- t: -{Easy! {2 [3 4]}} - ---- t dump: -a: Easy! -b: - c: 2 - d: [3, 4] - - ---- m: -map[a:Easy! b:map[c:2 d:[3 4]]] - ---- m dump: -a: Easy! -b: - c: 2 - d: - - 3 - - 4 -``` - +Forked from https://github.com/go-yaml/yaml diff --git a/decode_test.go b/decode_test.go index a0d57333..bd510516 100644 --- a/decode_test.go +++ b/decode_test.go @@ -25,7 +25,7 @@ import ( "strings" "time" - "github.com/zillow/go-yaml.v3" + "github.com/zillow/go-yaml" . "gopkg.in/check.v1" ) diff --git a/encode_test.go b/encode_test.go index 1f59f6fd..81ec187a 100644 --- a/encode_test.go +++ b/encode_test.go @@ -26,7 +26,7 @@ import ( "net" "os" - "github.com/zillow/go-yaml.v3" + "github.com/zillow/go-yaml" . "gopkg.in/check.v1" ) diff --git a/example_embedded_test.go b/example_embedded_test.go index 73f8b134..cce999d0 100644 --- a/example_embedded_test.go +++ b/example_embedded_test.go @@ -19,7 +19,7 @@ import ( "fmt" "log" - "github.com/zillow/go-yaml.v3" + "github.com/zillow/go-yaml" ) // An example showing how to unmarshal embedded diff --git a/go.mod b/go.mod index cc38560d..7735b35c 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module "github.com/zillow/go-yaml.v3" +module "github.com/zillow/go-yaml" require ( "gopkg.in/check.v1" v0.0.0-20161208181325-20d25e280405 diff --git a/limit_test.go b/limit_test.go index fb308081..fc16d60a 100644 --- a/limit_test.go +++ b/limit_test.go @@ -4,7 +4,7 @@ import ( "strings" "testing" - "github.com/zillow/go-yaml.v3" + "github.com/zillow/go-yaml" . "gopkg.in/check.v1" ) diff --git a/node_test.go b/node_test.go index 400122ae..a6dda587 100644 --- a/node_test.go +++ b/node_test.go @@ -23,7 +23,7 @@ import ( "io" "strings" - "github.com/zillow/go-yaml.v3" + "github.com/zillow/go-yaml" . "gopkg.in/check.v1" )