| Commit message (Collapse) | Author | Age | Files |
|---|
| |
|
|
| |
Upgrades to latest release of Go for CI.
This requires switching staticcheck to the latest release as well.
|
| | |
|
| |
|
|
| |
Release notes for v1.3.0 had an incorrect link for changes included
in v1.3.0; fixing this before we actually tag a release with this.
|
| | |
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Adds a Dockerfile that builds sally using a phased Docker build.
The first phase builds sally,
and the second phase publishes a scratch image
with just sally.
If Uber publishes this to a container registry,
a user can use it like so:
% vim sally.yaml # create a sally yaml
% cat > Dockerfile
FROM sally:latest
COPY sally.yaml /sally.yaml
% docker build .
Even without publishing, this provides an example
of how to build sally for deployment.
Testing:
I verified the instructions above locally
by tagging locally with:
% docker build -t sally:latest
I'm also using a variation of this Dockerfile in production
right now for my own hosted instance of sally.
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
* config: Don't require packages to be alphabetical
The configuration parser requries that
entries in the 'packages' section
are in alphabetical order.
It will fail parsing if that's not the case,
even if the configuration is otherwise valid.
This seems like an unnecessary artificial limitation.
Enforcing such a convention should be the user's choice.
This change deletes this limitation.
* Upgrade to yaml.v3
* template: Use a more fluid layout (#67)
Instead of using a table, take advantage of the grid layout.
We still print a table of sorts,
but it's more fluid in appearance based on width of the screen.
On narrower screens, we'll show a listing
where each item has a description label next to it
rather than at the top.
* Add support for package descriptions (#68)
* template: Use a more fluid layout
Instead of using a table, take advantage of the grid layout.
We still print a table of sorts,
but it's more fluid in appearance based on width of the screen.
On narrower screens, we'll show a listing
where each item has a description label next to it
rather than at the top.
* Add support for package descrpitions
Packages may now optionally specify a description.
If specified, this is printed below the package information,
indented one column to make it stand out.
Co-authored-by: Sung Yoon Whang <sungyoonwhang@gmail.com>
Co-authored-by: Sung Yoon Whang <sungyoonwhang@gmail.com>
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
| |
This drops the third-party HTTP router dependency.
This dependency wasn't strictly necessary
since our routing needs are quite basic:
- `/$name` and `/$name/*` for all registered packages
- `/` for root
This is easily accomplished with `http.ServeMux`:
- register `/$name` and `/$name/`.
The latter will receive all subpackage requests.
- register `/` and reject anything that isn't for exactly `/`.
|
| |
|
|
|
|
| |
This dependency is used to format and compare HTML.
An additional dependency isn't needed;
we can use the existing (previously transitive) x/net package
to reformat and compare the HTML.
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
* template: Use a more fluid layout
Instead of using a table, take advantage of the grid layout.
We still print a table of sorts,
but it's more fluid in appearance based on width of the screen.
On narrower screens, we'll show a listing
where each item has a description label next to it
rather than at the top.
* Add support for package descrpitions
Packages may now optionally specify a description.
If specified, this is printed below the package information,
indented one column to make it stand out.
Co-authored-by: Sung Yoon Whang <sungyoonwhang@gmail.com>
|
| |
|
|
|
|
|
|
|
| |
Instead of using a table, take advantage of the grid layout.
We still print a table of sorts,
but it's more fluid in appearance based on width of the screen.
On narrower screens, we'll show a listing
where each item has a description label next to it
rather than at the top.
|
| |
|
|
|
|
|
|
|
|
|
|
|
| |
The configuration parser requries that
entries in the 'packages' section
are in alphabetical order.
It will fail parsing if that's not the case,
even if the configuration is otherwise valid.
This seems like an unnecessary artificial limitation.
Enforcing such a convention should be the user's choice.
This change deletes this limitation.
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Bumps [github.com/stretchr/testify](https://github.com/stretchr/testify) from 1.2.2 to 1.8.1.
- [Release notes](https://github.com/stretchr/testify/releases)
- [Commits](https://github.com/stretchr/testify/compare/v1.2.2...v1.8.1)
---
updated-dependencies:
- dependency-name: github.com/stretchr/testify
dependency-type: direct:production
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
|
| |
|
|
|
|
| |
Since upgrading to Go 1.19 we are seeing linter error due to
usage of the deprecated io/ioutil package.
This removes the usage of io/ioutil package.
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
This simplifies the Makefile significantly,
borrowing patterns we've used in other projects.
Namely:
- Set GOBIN to a bin subdirectory
so that we can `go install` dependencies into it.
- Use a shared TEST_FLAGS for `make test` and `make cover`.
Without this, we're not running with data race detection in CI.
- Build lint step out of separate golint and staticcheck steps.
In the future, a gofmt step may also be added.
- Move tools dependencies into an unpublished subpackage.
Note: I didn't mess with the 'clean' and 'run' targets
at the bottom of the file even though they're not necessary
to avoid a merge conflict with #60.
|
| |
|
|
|
|
|
| |
Adds more details on how to configure sally
and what the required and optional fields are.
Also updates the installation instructions
since you can't `go get` the binary anymore.
|
| |
|
|
|
|
|
| |
This was all added back when these tests were running on Travis CI
and attempted to create an isolated build of sally.
This is all no longer necessary because GitHub Actions and Go modules
provide enough isolation.
|
| |
|
|
|
|
| |
sally is a binary, not a library
so it's okay to keep it on the latest dependencies.
This sets up dependabot updates for Go modules used by sally.
|
| |
|
|
|
|
|
|
|
|
| |
This updates sally to build and test against Go 1.19.
Additionally, this upgrades the GitHub Action versions
for checkout and setup-go.
One of the features in setup-go v3 is that caching is built-in
and opted-into with `cache: true`.
Non-CI changes: gofmt, drop ioutil
|
| | |
|
| |
|
|
|
|
|
|
| |
This releases Sally v1.2.0 with several changes and a couple community
contributions.
In updating the changelog, I moved the reference links from the bottom
to the section for each version because otherwise it's easy to forget to
add these.
|
| |
|
|
|
|
|
|
| |
When we originally switched to pkg.go.dev (#40),
it did not offer documentation badges so we relied on a third-party
service.
That's no longer true (https://pkg.go.dev/badge) so we can use
pkg.go.dev's more "on-brand" badges for this.
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Update all dependencies,
use Go 1.18 to build and test,
and delete outdated `bindata` clause in Makefile
(we switched to `go:embed` in #50).
Other minor changes:
- Fix the golint import path
(it switched to golang.org/x/lint long before it was deprecated)
and fix the failing lint check.
(Switching from golint to revive is out of scope for this PR.)
- Delete .envrc -- this was transitional for when Go modules were
optional.
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Sally accepts the base vanity URL (e.g. `go.uber.org`) in a top-level
`url` key. This applies to all packages listed in the configuration.
Add support for overriding the `url` on a per-package basis.
This will provide for an easier transition period when migrating Go
packages of an organization between hosts, for example from BitBucket
to GitHub.
With this, source code can be modified across the various
repositories over time to use the new vanity URL. For example, some
packages will use a URL of bitbucketurl.org and some will use
mycoolgoimportvanity.org in their source code imports.
Other than the use-case outlined above, this feature adds flexibility
to the vanity server to support more than one vanity URL when used
behind an ingress controller.
|
| |
|
|
|
|
|
|
| |
Go 1.16 includes a `//go:embed` directive that obviates the need for
bindata. Use `//go:embed` instead of bindata for templates used in
sally.
Signed-off-by: Luciano Nooijen <luciano@bytecode.nl>
Co-authored-by: Abhinav Gupta <abg@uber.com>
|
| |
|
|
|
|
| |
sally is not a library, so there's no reason to test it with two
versions of Go.
Use the latest version of Go to build and test it.
|
| |\
| |
| | |
fossa: Run separately, only on push
|
| |/
|
|
|
|
|
|
| |
FOSSA analysis currently blocks CI on pull requests because they are
denied access to secrets.
Run FOSSA as a separate job only when we push to a branch of the
project.
|
| |
|
|
|
| |
Add a FOSSA check to the build steps.
Resolves: GO-468
|
| |
|
|
| |
Support specifying the branch from which source will be served in
the YAML configuration.
|
| |
|
| |
Set up CI with GitHub actions.
|
| | |
|
| | |
|
| |
|
|
|
|
|
| |
pkg.go.dev does not serve a badge like godoc.org. This change switches
the image over to one provided by shields.io.
Note that this uses the style "for-the-badge" from shields.io.
|
| |
|
|
|
| |
* Release v1.1.0
|
| |
|
|
|
|
| |
Update our default Godoc server from `` to the shiny, new `https://pkg.go.dev/`
See https://github.com/uber-go/sally/issues/39, T4832833
|
| | |
|
| |
|
|
|
| |
This adds the ability to change the godoc.org instance used by Sally to
link to documentation by providing a new `godoc` section in the
configuration.
|
| | |
|
| |
|
|
|
|
|
|
| |
This uses go-bindata/go-bindata to bundle the template in the binary.
I also realized that the handler test was now broken because we were
checking the exact contents of the index page in the test. This change
fixes that too.
|
| | |
|
| |
|
|
|
|
| |
This adds a changelog to the repository. Since we have no prior tagged
releases to compare against, this will be the first real release of the
tool.
|
| | |
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
This commit modernizes the repository organization a bit.
In short, this,
- Upgrades to Go 1.11.
- Uses Go modules instead of Glide.
- Drops errcheck, which we rarely use in our codebase internally.
- Uses `./...` to run build, tests, etc. since that does not have to
account for vendor anymore.
- Drops `-installsuffix cgo` from the production build. This was a
workaround for pre-1.10 versions of Go. See
https://github.com/golang/go/issues/9344#issuecomment-69944514.
- Uses a tools.go as recommended in [go-modules-by-example/tools][1] to
pin to tool dependencies.
- Uses `go run` instead of `go install`ing tools globally.
[1]: https://github.com/go-modules-by-example/index/tree/master/010_tools
Tested locally with `make docker-launch`.
|
| |
|
|
|
| |
The dependencies for this repository haven't been updated in a while.
This commit updates its dependencies, updating the import path for
staticcheck in the process.
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
| | |
|
