tailscale / depaware Goto Github PK

View Code? Open in Web Editor NEW

436.0 436.0 10.0 37 KB

depaware makes you aware of your Go dependencies

License: BSD 3-Clause "New" or "Revised" License

Go 100.00%

depaware's Introduction

Tailscale

https://tailscale.com

Private WireGuard® networks made easy

Overview

This repository contains the majority of Tailscale's open source code. Notably, it includes the tailscaled daemon and the tailscale CLI tool. The tailscaled daemon runs on Linux, Windows, macOS, and to varying degrees on FreeBSD and OpenBSD. The Tailscale iOS and Android apps use this repo's code, but this repo doesn't contain the mobile GUI code.

Other Tailscale repos of note:

the Android app is at https://github.com/tailscale/tailscale-android
the Synology package is at https://github.com/tailscale/tailscale-synology
the QNAP package is at https://github.com/tailscale/tailscale-qpkg
the Chocolatey packaging is at https://github.com/tailscale/tailscale-chocolatey

For background on which parts of Tailscale are open source and why, see https://tailscale.com/opensource/.

Using

We serve packages for a variety of distros and platforms at https://pkgs.tailscale.com.

Other clients

The macOS, iOS, and Windows clients use the code in this repository but additionally include small GUI wrappers. The GUI wrappers on non-open source platforms are themselves not open source.

Building

We always require the latest Go release, currently Go 1.23. (While we build releases with our Go fork, its use is not required.)

go install tailscale.com/cmd/tailscale{,d}

If you're packaging Tailscale for distribution, use build_dist.sh instead, to burn commit IDs and version info into the binaries:

./build_dist.sh tailscale.com/cmd/tailscale
./build_dist.sh tailscale.com/cmd/tailscaled

If your distro has conventions that preclude the use of build_dist.sh, please do the equivalent of what it does in your distro's way, so that bug reports contain useful version information.

Bugs

Please file any issues about this code or the hosted service on the issue tracker.

Contributing

PRs welcome! But please file bugs. Commit messages should reference bugs.

We require Developer Certificate of Origin Signed-off-by lines in commits.

See git log for our commit message style. It's basically the same as Go's style.

About Us

Tailscale is primarily developed by the people at https://github.com/orgs/tailscale/people. For other contributors, see:

Legal

WireGuard is a registered trademark of Jason A. Donenfeld.

depaware's People

Contributors

Stargazers

Watchers

Forkers

bonedaddy isgasho zeta1999 etsangsplk suryatmodulus andrewpolidori isabella232 felixge maisem

depaware's Issues

reduce diffs due to introducing lexicographically prior importing packages

depaware.txt diffs can be very noisy. See e.g. the diff in https://github.com/tailscale/depaware/pull/3/commits. Many of those changes are of the form:

-        bytes                                                        from encoding/json+
+        bytes                                                        from bufio+

I propose that when a package is imported by >1 package, we write <multiple packages> instead of using lexifirst+. This provides less information, but will be much more stable.

Optionally, we could also add a -all flag (better name welcome) that spells out every single importing package like bufio,encoding/json, instead of <multiple packages>. That would be useful for someone actively trying to cut dependencies. And teams might choose to use it all the time; with a good intra-line diff, it'd generate usable diffs again.

I'm willing to implementation, but feedback on design requested first.

Separate unsafe and cgo

While both might be problematic in terms of GC or race detection, CGO can introduce additional issues for cross-compiling. It would be great if CGO was recognizable on its own. Maybe different bomb types or bombs plus U/C code?

depaware: prints colorful control characters even when output to a file

Typically code using control characters should check the terminal on the fd before printing.

Support multiple packages

Most pkg tools support specifying ./... or multiple packages.

golang.org/x/tools/go/packages can come in handy.

depaware: -update flag ignored if used in the wrong place

go run github.com/tailscale/depaware -check tailscale.io/cmd/cmdname -update

Running this does a -check and completely ignores -update, producing no error message.

where did you get the license text?

The 2-Clause BSD License doesn't contain that sentence.

https://opensource.org/licenses/BSD-2-Clause

consider showing test-only dependencies

The ability to more easily see what are test-only dependencies for modules is a common request for cmd/go.

Consider supporting it here, either by highlighting a test-only dependency or by highlighting a non-test dependency.

There are different ways to determine this, but one way is this, which shows the modules used in your build excluding test-only dependencies:

go list -deps -f '{{with .Module}}{{.Path}} {{.Version}}{{end}}' ./... | sort -u