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

Jump to bottom

[cleanup] Remove extraneous variables from provider docs build #4671

Open

guineveresaenger opened this issue Jun 3, 2024 · 0 comments

Contributor

guineveresaenger commented Jun 3, 2024

https://github.com/pulumi/registry/blob/master/.github/workflows/publish-provider-update.yml, which we are calling for internal provider updates, has a few unused variables as well as a somewhat unnecessary distinction between PROVIDER_NAME and PROVIDER_SHORT_NAME (we're only using the former for info purposes, and could easily construct it from the latter).

The text was updated successfully, but these errors were encountered:

github-actions bot added the needs-triage label

guineveresaenger mentioned this issue

Refactor: Use GHA native dispatch for registry metadata build kickoff pulumi/ci-mgmt#958

Merged

sean1588 removed the needs-triage label

guineveresaenger added a commit to pulumi/ci-mgmt that referenced this issue


          Refactor: Use GHA native dispatch for registry metadata build kickoff (…

2e43e3e

…#958)

This pull request removes the dependency on `pulumictl` for the bridged
provider registry docs dispatch.

### Before this change
Currently, the [Create Docs
Build](https://github.com/pulumi/ci-mgmt/blob/master/provider-ci/internal/pkg/templates/bridged-provider/.github/workflows/release.yml#L24)
step in the Release Workflow calls into a [Pulumictl
command](https://github.com/pulumi/pulumictl/blob/master/cmd/pulumictl/create/docs-build/cli.go)
that triggers the [Publish Provider
Update](https://github.com/pulumi/registry/blob/master/.github/workflows/publish-provider-update.yml)
Workflow, building metadata, in pulumi/registry.

`publish.yml`(provider) -> `pulumictl`(bespoke command) ->
`publish-provider-update`(registry)

### After this change
Use `peter-evans/repository-dispatch@v3` to dispatch the
`resource-provider` event that [already exists on the registry
`publish-provider-update`
Workflow](https://github.com/pulumi/registry/blob/master/.github/workflows/publish-provider-update.yml#L16),
removing the need for pulumictl.

The registry's Action has a few fields we do not use. See [example
run](https://github.com/pulumi/registry/actions/runs/9350133653/job/25732951804#step:2:4).
Filed pulumi/registry#4671 to track. The
repository dispatch payload therefore only contains:

```
"project": "${{ github.repository }}", - this is somewhat unnecessary but makes for a safe refactor without having to change the registry workflow file
"shortname": "#{{ .Config.provider }}#", - Just the provider name without `pulumi-` prefix
"ref": "${{ github.ref_name }}" - This is the tag name of the release.
```

*Note:* This pull request changes bridged providers only since we are
currently working on unifying templating for native and bridged
providers. I'm happy to add native provider changes to this effect if
reviewers would prefer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment