Buildspec in CloudFormation template or separate buildspec.yml file?

Question

I am updating an old CloudFormation template. The template has three CodeBuild projects and one CodePipeline to tie everything together. The CodeBuild projects have the BuildSpec right in the template. The BuildSpecs are not very complex, but they are out of date.
My question is whether it would be better to continue to work with the BuildSpec(s) in the CloudFormation template, or to create them as separate buildspec.yml files in my repository? What are the pros and cons? What are best practices in this area?

Accepted Answer

Hi,

Whether to keep the BuildSpec directly in the CloudFormation template or to manage them as separate buildspec.yml files depends on your specific use case and team preferences. \
In general, the practice followed is:
- if the BuildSpec is very small and not meant to be reused, then it is good to have it embedded.
- if the BuildSpec is complex and being reused, and requires frequent maintenance/updates, it is ideal to have it in separate files.

I have tried to summarize the difference in points to help you make an informed decision:
1. BuildSpec in CloudFormation Template:
    - Pros: Easier management, versioning tied with infrastructure.
    - Cons: Limited reusability, less visibility.
2. Separate buildspec.yml Files:
    - Pros: Better reusability, enhanced visibility, easy integration with version control tools.
    - Cons: Slightly more complex deployment, potential sync issues.

In my opinion, separate buildspec.yml files are the best, providing easier management, better extensibility, reusability, and future-proof solution.

Thanks, \
Atul

Buildspec in CloudFormation template or separate buildspec.yml file?

Relevant content