Will Norris
3ec5be3f51
This file was never truly necessary and has never actually been used in the history of Tailscale's open source releases. A Brief History of AUTHORS files --- The AUTHORS file was a pattern developed at Google, originally for Chromium, then adopted by Go and a bunch of other projects. The problem was that Chromium originally had a copyright line only recognizing Google as the copyright holder. Because Google (and most open source projects) do not require copyright assignemnt for contributions, each contributor maintains their copyright. Some large corporate contributors then tried to add their own name to the copyright line in the LICENSE file or in file headers. This quickly becomes unwieldy, and puts a tremendous burden on anyone building on top of Chromium, since the license requires that they keep all copyright lines intact. The compromise was to create an AUTHORS file that would list all of the copyright holders. The LICENSE file and source file headers would then include that list by reference, listing the copyright holder as "The Chromium Authors". This also become cumbersome to simply keep the file up to date with a high rate of new contributors. Plus it's not always obvious who the copyright holder is. Sometimes it is the individual making the contribution, but many times it may be their employer. There is no way for the proejct maintainer to know. Eventually, Google changed their policy to no longer recommend trying to keep the AUTHORS file up to date proactively, and instead to only add to it when requested: https://opensource.google/docs/releasing/authors. They are also clear that: > Adding contributors to the AUTHORS file is entirely within the > project's discretion and has no implications for copyright ownership. It was primarily added to appease a small number of large contributors that insisted that they be recognized as copyright holders (which was entirely their right to do). But it's not truly necessary, and not even the most accurate way of identifying contributors and/or copyright holders. In practice, we've never added anyone to our AUTHORS file. It only lists Tailscale, so it's not really serving any purpose. It also causes confusion because Tailscalars put the "Tailscale Inc & AUTHORS" header in other open source repos which don't actually have an AUTHORS file, so it's ambiguous what that means. Instead, we just acknowledge that the contributors to Tailscale (whoever they are) are copyright holders for their individual contributions. We also have the benefit of using the DCO (developercertificate.org) which provides some additional certification of their right to make the contribution. The source file changes were purely mechanical with: git ls-files | xargs sed -i -e 's/\(Tailscale Inc &\) AUTHORS/\1 contributors/g' Updates #cleanup Change-Id: Ia101a4a3005adb9118051b3416f5a64a4a45987d Signed-off-by: Will Norris <will@tailscale.com>
85 lines
2.5 KiB
Go
85 lines
2.5 KiB
Go
// Copyright (c) Tailscale Inc & contributors
|
|
// SPDX-License-Identifier: BSD-3-Clause
|
|
|
|
// Package jsonoutput provides stable and versioned JSON serialisation for CLI output.
|
|
// This allows us to provide stable output to scripts/clients, but also make
|
|
// breaking changes to the output when it's useful.
|
|
//
|
|
// Historically we only used `--json` as a boolean flag, so changing the output
|
|
// could break scripts that rely on the existing format.
|
|
//
|
|
// This package allows callers to pass a version number to `--json` and get
|
|
// a consistent output. We'll bump the version when we make a breaking change
|
|
// that's likely to break scripts that rely on the existing output, e.g. if
|
|
// we remove a field or change the type/format.
|
|
//
|
|
// Passing just the boolean flag `--json` will always return v1, to preserve
|
|
// compatibility with scripts written before we versioned our output.
|
|
package jsonoutput
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"strconv"
|
|
)
|
|
|
|
// JSONSchemaVersion implements flag.Value, and tracks whether the CLI has
|
|
// been called with `--json`, and if so, with what value.
|
|
type JSONSchemaVersion struct {
|
|
// IsSet tracks if the flag was provided at all.
|
|
IsSet bool
|
|
|
|
// Value tracks the desired schema version, which defaults to 1 if
|
|
// the user passes `--json` without an argument.
|
|
Value int
|
|
}
|
|
|
|
// String returns the default value which is printed in the CLI help text.
|
|
func (v *JSONSchemaVersion) String() string {
|
|
if v.IsSet {
|
|
return strconv.Itoa(v.Value)
|
|
} else {
|
|
return "(not set)"
|
|
}
|
|
}
|
|
|
|
// Set is called when the user passes the flag as a command-line argument.
|
|
func (v *JSONSchemaVersion) Set(s string) error {
|
|
if v.IsSet {
|
|
return errors.New("received multiple instances of --json; only pass it once")
|
|
}
|
|
|
|
v.IsSet = true
|
|
|
|
// If the user doesn't supply a schema version, default to 1.
|
|
// This ensures that any existing scripts will continue to get their
|
|
// current output.
|
|
if s == "true" {
|
|
v.Value = 1
|
|
return nil
|
|
}
|
|
|
|
version, err := strconv.Atoi(s)
|
|
if err != nil {
|
|
return fmt.Errorf("invalid integer value passed to --json: %q", s)
|
|
}
|
|
v.Value = version
|
|
return nil
|
|
}
|
|
|
|
// IsBoolFlag tells the flag package that JSONSchemaVersion can be set
|
|
// without an argument.
|
|
func (v *JSONSchemaVersion) IsBoolFlag() bool {
|
|
return true
|
|
}
|
|
|
|
// ResponseEnvelope is a set of fields common to all versioned JSON output.
|
|
type ResponseEnvelope struct {
|
|
// SchemaVersion is the version of the JSON output, e.g. "1", "2", "3"
|
|
SchemaVersion string
|
|
|
|
// ResponseWarning tells a user if a newer version of the JSON output
|
|
// is available.
|
|
ResponseWarning string `json:"_WARNING,omitzero"`
|
|
}
|