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

Add detail to CI/CD section in setup documentation #2551

Open
adamnfish opened this issue Jan 7, 2025 · 1 comment
Open

Add detail to CI/CD section in setup documentation #2551

adamnfish opened this issue Jan 7, 2025 · 1 comment

Comments

@adamnfish
Copy link

adamnfish commented Jan 7, 2025

The setting up a new project documentation glosses over how to connect the CDK synth output with the CI/CD steps.

https://github.com/guardian/cdk/blob/main/docs/setting-up-a-gucdk-project.md

It would be great if it could mention actions-riff-raff, and show how that action's contentDirectories key is used to scoop up the cloudformation template produced by the CDK synth step.

Ideally it'd also mention the riff-raff.yaml file, and show how that is provided to the configPath config key of actions-riff-raff.

I think connecting all these concepts up here will help make this seem more approachable.

@adamnfish
Copy link
Author

I'd also point to the riffraff-platform permission needing to match the project name that gets defined in the guardian/actions-riff-raff step of the CI/CD workflow.

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

No branches or pull requests

1 participant