Skip to content
This repository has been archived by the owner on Dec 15, 2022. It is now read-only.

Directions for calling ./hack/prepare.sh in the provider guide #167

Merged
merged 1 commit into from
Dec 3, 2021

Conversation

ulucinar
Copy link
Collaborator

@ulucinar ulucinar commented Dec 3, 2021

Description of your changes

In the context of crossplane-contrib/provider-jet-template#3, this change proposes to move repo preparation shell commands into the script hack/prepare.sh of crossplane-contrib/provider-jet-template. This has some advantages like:

  • Simplifying the provider guide a bit
  • Decoupling the two repos a bit: For instance, as we might further evolve the hack/prepare.sh script in crossplane-contrib/provider-jet-template, the guide just instructs the user to call it.

Depends on crossplane-contrib/provider-jet-template#9

I have:

  • Read and followed Crossplane's contribution process.
  • Run make reviewable to ensure this PR is ready for review.
  • Added backport release-x.y labels to auto-backport this PR if necessary.

How has this code been tested

Not a full test of the guide, however, tested by running hack/prepare.sh in crossplane-contrib/provider-jet-template#9.

Signed-off-by: Alper Rifat Ulucinar <ulucinar@users.noreply.github.com>
@ulucinar ulucinar requested a review from turkenh December 3, 2021 14:30
Copy link
Member

@turkenh turkenh left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @ulucinar!

@ulucinar
Copy link
Collaborator Author

ulucinar commented Dec 3, 2021

Thank you @turkenh.

@ulucinar ulucinar merged commit 3f0d22f into crossplane:main Dec 3, 2021
@ulucinar ulucinar deleted the call-prepare branch December 3, 2021 14:59
@@ -20,17 +20,11 @@ be quite similar for any other Terraform provider.
export ProviderNameUpper=GitHub
```

2. Replace all occurrences of `template` with your provider name:
2. Run the `./hack/prepare.sh` script from repo root to prepare the repo, e.g., to
Copy link
Member

Choose a reason for hiding this comment

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

Looks like hack/prepare.sh wasn't committed.

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

Oh sorry!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants