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

fix: updated contributing instructions #149

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

JeffreyTsang0928
Copy link

…e ARN to connect the two planes

Issue # (if applicable)

Closes #.

Reason for this change

CONTRIBUTING.md does not instruct users to use the Eventbridge ARN from the control plane when deploying the core app plane, resulting in the deployment of the two planes without any communication. This will also result in the failure of the test scripts when provisioning and deprovisioning tenants, as there is no prior instruction to connect the two planes when deploying.

Description of changes

Edited CONTRIBUTING.md

Description of how you validated changes

N/A

Checklist

  • My code adheres to the CONTRIBUTING GUIDE
  • I have updated the relevant documentation (if applicable).

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.

1. Write tests for any changed code and commit
1. Create a PR.

- Once the control plane has been deployed, obtain the ARN of the newly deployed event bus [here](https://us-east-1.console.aws.amazon.com/events/home?region=us-east-1#/eventbuses)
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a region-specific URL, which will be confusing for customers deploying outside of us-east-1.

Maybe we can ask them to review the outputs of the ControlPlane stack to find the event bus ARN?

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

Successfully merging this pull request may close these issues.

2 participants