Migrate to full use of tools/resourcedocsgen

[guineveresaenger]

Description

This pull request migrates functionality from https://github.com/pulumi/registrygen to tools/resourcedocsgen which is more actively maintained, in the aim of retiring registrygen.

Before this change

(to the best of my knowledge)

• All providers were using registrygen metadata to generate metadata files, these are Pulumi.yaml in the themes/default/datafolder and_index.mdandconfiguration-installation.mdin thethemes/default/content` folder.
• Additionally, 3rd party providers were using a version check functionality to verify whether packages should be updated (on a cron-based Workflow).
• All providers are using resourcedocsgen to build API docs. This pull request does not change that.

After this change

• All providers use resourcedocsgen metadata
• 3rd party providers use resourcedocsgen pkgversion
• Both commands are updated to contain the functionality of registrygen at this time, with once exception, see below.

It has been a constant source of confusion to maintainers on which tool to use when, as they're very similar and both come with unused code that looks like it's the real thing (but we use the other tool for that). I have personally wasted entirely too much time on this discrepancy.

After this pull request merges, we should be able to retire pulumi/registrygen.

I recommend reviewing these commits one by one:

1. Migrate registrygen's metadata command to tools/resourcedocsgen
   Moves the current, stable functionality we've been using to resourcedocsgen. There are functionality and use updates.
2. Ignore the build resourcedocsgen binary - you can ignore the gitignore
3. Special-case Pulumi for top-level config files not found This commit sends an error for 3rd party providers if the required docs files cannot be found. This will mostly help identify issues automatically upon first-time publication of a 3rd party provider to the pulumi registry. We continue to return nil for Pulumi providers, so that we continue to use the hard coded config docs files in the registry until we've implemented Generate documentation for provider configuration #4749 (work underway).
4. Update Go module name and update references
   Follows Go module naming protocol. This is a cleanup from the migration from pulumi/docs.
5. Use resourcedocsgen for generating package metadata - Use new metadata command in CI
6. Transport pkgversion check to resourcedocsgen - for 3rd party providers, import the pkgversion check as well
7. Replace pkgversion check - Use new pkgversion command in CI.

[github-actions]

Your site preview for commit f33fde0 is ready! 🎉

http://registry--origin-pr-4663-f33fde09.s3-website.us-west-2.amazonaws.com/registry.

[iwahbe]

I love this!

[github-actions]

Your site preview for commit 64068d9 is ready! 🎉

http://registry--origin-pr-4663-64068d91.s3-website.us-west-2.amazonaws.com/registry.

[sean1588]

This is looking great @guineveresaenger ! Thanks so much for doing this!! I tested out these commands locally and outputs match what registrygen was doing before, so looks like the migration is working as expected! Just one thing to address.

Also thank you for this:

This commit sends an error for 3rd party providers if the required docs files cannot be found.

[sean1588]

Suggested change

	cd tools/resourcedocsgen && go run github.com/pulumi/registry/tools/resourcedocsgen \
	resourcedocsgen metadata --providerName=${{ env.PROVIDER_SHORT_NAME }} --repoSlug pulumi/pulumi-${{ env.PROVIDER_SHORT_NAME }} --schemaFile="${{ env.PROVIDER_SCHEMA_PATH }}" --version="${{ env.PROVIDER_VERSION }}" --publisher Pulumi
	cd tools/resourcedocsgen && go run github.com/pulumi/registry/tools/resourcedocsgen \
	metadata --providerName=${{ env.PROVIDER_SHORT_NAME }} --repoSlug pulumi/pulumi-${{ env.PROVIDER_SHORT_NAME }} --schemaFile="${{ env.PROVIDER_SCHEMA_PATH }}" --version="${{ env.PROVIDER_VERSION }}" --publisher Pulumi

I don't think calling resourcedocsgen here will work since you are doing a go run in the line above. So probably just need to pass it the subcommands and args like you are doing here

[guineveresaenger]

oh! thank you for this catch!

[cnunciato]

Aside from Sean's comment, this all looks great to me. Thanks so much @guineveresaenger! I've been confused by the existence of both of these also.

[github-actions]

Your site preview for commit e8bfa18 is ready! 🎉

http://registry--origin-pr-4663-e8bfa186.s3-website.us-west-2.amazonaws.com/registry.

[github-actions]

Your site preview for commit 4ba53ce is ready! 🎉

http://registry--origin-pr-4663-4ba53ceb.s3-website.us-west-2.amazonaws.com/registry.

[sean1588]

LGTM 🚀

[github-actions]

Site previews for this pull request have been removed. ✨