Skip to content

Add option to ignore deprecated resources and data-sources #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
detro merged 3 commits into from
Jun 28, 2022
Merged

Add option to ignore deprecated resources and data-sources #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
89ca8db
Add option to ignore deprecated resources and data-sources
remilapeyre Jun 19, 2022
7b12b95
Merge remote-tracking branch 'origin/main' into ignore-deprecated
remilapeyre Jun 27, 2022
1ec06ff
Update CHANGELOG
remilapeyre Jun 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# 0.10.2 (Unreleased)

NEW FEATURES:

* cmd/tfplugindocs: Additional CLI argument `ignore-deprecated` allows to skip deprecated resources and data-sources when generating docs ([#154](https://github.com/hashicorp/terraform-plugin-docs/pull/154)).

BUG FIXES:

* cmd/tfplugindocs: Pass through filepaths for `examples` and `import` to allow use of `HasExample` and `HasImport` template helpers in custom templates ([#155](https://github.com/hashicorp/terraform-plugin-docs/pull/155)).
Expand Down
5 changes: 4 additions & 1 deletion internal/cmd/generate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ import (
type generateCmd struct {
commonCmd

flagLegacySidebar bool
flagLegacySidebar bool
flagIgnoreDeprecated bool

flagProviderName string
flagRenderedProviderName string
Expand Down Expand Up @@ -75,6 +76,7 @@ func (cmd *generateCmd) Flags() *flag.FlagSet {
fs.StringVar(&cmd.flagWebsiteTmpDir, "website-temp-dir", "", "temporary directory (used during generation)")
fs.StringVar(&cmd.flagWebsiteSourceDir, "website-source-dir", "templates", "templates directory")
fs.StringVar(&cmd.tfVersion, "tf-version", "", "terraform binary version to download")
fs.BoolVar(&cmd.flagIgnoreDeprecated, "ignore-deprecated", false, "don't generate documentation for deprecated resources and data-sources")
return fs
}

Expand All @@ -100,6 +102,7 @@ func (cmd *generateCmd) runInternal() error {
cmd.flagWebsiteTmpDir,
cmd.flagWebsiteSourceDir,
cmd.tfVersion,
cmd.flagIgnoreDeprecated,
)
if err != nil {
return fmt.Errorf("unable to generate website: %w", err)
Expand Down
20 changes: 15 additions & 5 deletions internal/provider/generate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,9 @@ var (
)

type generator struct {
legacySidebar bool
tfVersion string
ignoreDeprecated bool
legacySidebar bool
tfVersion string

providerName string
renderedProviderName string
Expand All @@ -85,10 +86,11 @@ func (g *generator) warnf(format string, a ...interface{}) {
g.ui.Warn(fmt.Sprintf(format, a...))
}

func Generate(ui cli.Ui, legacySidebar bool, providerName, renderedProviderName, renderedWebsiteDir, examplesDir, websiteTmpDir, websiteSourceDir, tfVersion string) error {
func Generate(ui cli.Ui, legacySidebar bool, providerName, renderedProviderName, renderedWebsiteDir, examplesDir, websiteTmpDir, websiteSourceDir, tfVersion string, ignoreDeprecated bool) error {
g := &generator{
legacySidebar: legacySidebar,
tfVersion: tfVersion,
ignoreDeprecated: ignoreDeprecated,
legacySidebar: legacySidebar,
tfVersion: tfVersion,

providerName: providerName,
renderedProviderName: renderedProviderName,
Expand Down Expand Up @@ -319,6 +321,10 @@ func (g *generator) renderMissingProviderDoc(providerName string, schema *tfjson
func (g *generator) renderMissingDocs(providerName string, providerSchema *tfjson.ProviderSchema) error {
g.infof("generating missing resource content")
for name, schema := range providerSchema.ResourceSchemas {
if g.ignoreDeprecated && schema.Block.Deprecated {
continue
}

err := g.renderMissingResourceDoc(providerName, name, "Resource", schema,
websiteResourceFileTemplate,
websiteResourceFallbackFileTemplate,
Expand All @@ -332,6 +338,10 @@ func (g *generator) renderMissingDocs(providerName string, providerSchema *tfjso

g.infof("generating missing data source content")
for name, schema := range providerSchema.DataSourceSchemas {
if g.ignoreDeprecated && schema.Block.Deprecated {
continue
}

err := g.renderMissingResourceDoc(providerName, name, "Data Source", schema,
websiteDataSourceFileTemplate,
websiteDataSourceFallbackFileTemplate,
Expand Down