aboutsummaryrefslogtreecommitdiff
path: root/config.go (follow)
AgeCommit message (Collapse)AuthorFilesLines
2023-05-09Remove branch from PackageConfig struct (#93)Gravatar Sung Yoon Whang 1-17/+0
* Remove branch from PackageConfig struct With #92, branch is no longer necessary from PackageConfig struct since go-source tag was removed. This removes Branch field from PackageConfig. * update README
2023-04-28config: Rename Package to PackageConfig, add docs (#84)Gravatar Abhinav Gupta 1-11/+40
Renames the Package struct to PackageConfig to make it clear that it is a configuration struct. This differentiation will help disconnect the configuration-level representation from the runtime representation of this information. This patch also adds documentation to the config package that was previously missing.
2023-01-23Upgrade to yaml.v3 (#69)Gravatar Abhinav Gupta 1-1/+1
* 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>
2023-01-23Add support for package descriptions (#68)Gravatar Abhinav Gupta 1-0/+2
* 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>
2023-01-23config: Don't require packages to be alphabetical (#66)Gravatar Abhinav Gupta 1-31/+4
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.
2022-12-18ci: Use Go 1.19 and update GH actions (#58)Gravatar Abhinav Gupta 1-2/+2
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
2022-01-03Support package-level overrides for URLs (#52)Gravatar Tyler Sullivan 1-0/+1
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.
2021-05-18Allow setting branch (#46)Gravatar Jan-Philipp Benecke 1-1/+11
Support specifying the branch from which source will be served in the YAML configuration.
2020-02-12Update Godoc server to pkg.go.dev (#40)Gravatar SyrieBianco 1-2/+2
Update our default Godoc server from `` to the shiny, new `https://pkg.go.dev/` See https://github.com/uber-go/sally/issues/39, T4832833
2019-03-05Support changing godoc instance (#38)Gravatar Diego Bernardes 1-1/+17
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.
2016-10-27Enforce alphabetical ordering of packages in YAML config (#22)Gravatar Garrett Squire 1-4/+33
2016-10-12Rework as HTTP server (#15)Gravatar Grayson Koonce 1-0/+34