Commits on Jan 18, 2022

1. Support additional unversioned types …

   github.com/tektoncd/pipeline has an additional type in https://github.com/tektoncd/pipeline/tree/main/pkg/apis/pipeline/pod which isn't versioned, and shouldn't be its own package section in the generated doc, but is referenced in versioned packages under `pkg/apis/pipeline`. This probably isn't the ideal way to have things set up, but it's what we've got. In order to use this tool to generate reference docs for Tekton Pipeline properly, we need to include the type in that package.
   
   To enable that, this adds an additional doc comment, `+gencrdrefdocs:unversionedTypes`. When that is found in a package's `doc.go` and that package isn't already being included normally, its types will be made available for reference by the "real" API packages, with `unversioned` as their version.
   
   I also fixed the existing `docCommentForceIncludes` - `pkg.DocComments` doesn't include the `// ` prefix, so searching for `// +gencrdrefdocs:force` would always fail. Therefore, I removed the `// ` prefix.
   
   Signed-off-by: Andrew Bayer <andrew.bayer@gmail.com>

   

   abayer committed Jan 18, 2022
   Configuration menu

   • View commit details
   • Copy full SHA for b3620f4
   • Browse repository at this point

   Copy the full SHA

   b3620f4 View commit details

   Browse the repository at this point in the history