Skip to content
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.

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

QoL: wiring up tfplugindocs to the code generation #170

Merged
merged 4 commits into from
Mar 21, 2022

Conversation

detro
Copy link
Contributor

@detro detro commented Mar 18, 2022

Ivan De Marino added 2 commits March 18, 2022 13:16
A call to `go generate` will now generate the documentation for the provider.
@detro detro requested a review from a team as a code owner March 18, 2022 13:18
@detro detro added this to the v3.2.0 milestone Mar 18, 2022
Copy link
Contributor

@bflad bflad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One quick question, otherwise looks good to me 🚀

GNUmakefile Outdated
TEST?=$$(go list ./...)
GOFMT_FILES?=$$(find . -name '*.go')
PKG_NAME=tls
GOLANGCILINT_INSTALLED := $(shell command -v golangci-lint 2> /dev/null)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Open question: Is this Windows compatible? If not, let's just let the underlying shell interpreter bubble its own "command not found" like error.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good point.

Until now our makefile for sure couldn't work on Windows (the use of find, xargs etc. make it impossible).

With this revamp, there is actually a chance that it might work on Windows (bar the make dependency).

I'll get rid of this: a "command not found" would deliver pretty much the same thing.
I'll just leave a link to golangci-lint to help future contributors.

@detro detro merged commit 7de8929 into main Mar 21, 2022
@detro detro deleted the detro/QoL-tfplugindocs-part2 branch March 21, 2022 12:09
@detro detro self-assigned this Mar 30, 2022
Copy link

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 28, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants