Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aws/codepipeline-starter-templates
A collection of starter templates for AWS CodePipeline to quickly set up and configure CI/CD pipelines
https://github.com/aws/codepipeline-starter-templates
aws codebuild codedeploy codepipeline
Last synced: about 9 hours ago
JSON representation
A collection of starter templates for AWS CodePipeline to quickly set up and configure CI/CD pipelines
- Host: GitHub
- URL: https://github.com/aws/codepipeline-starter-templates
- Owner: aws
- License: apache-2.0
- Created: 2024-11-06T20:14:45.000Z (9 days ago)
- Default Branch: main
- Last Pushed: 2024-11-12T21:42:45.000Z (3 days ago)
- Last Synced: 2024-11-12T22:29:51.749Z (3 days ago)
- Topics: aws, codebuild, codedeploy, codepipeline
- Language: TypeScript
- Homepage:
- Size: 51.8 KB
- Stars: 17
- Watchers: 5
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# CodePipeline Starter Templates
This repository contains a collection of starter templates for AWS CodePipeline, designed to help users quickly set up and configure their CI/CD pipelines for various project types and deployment scenarios.
## Repository Structure
- `/templates`: Contains the main components of the starter templates
- `/metadata`: JSON files describing each template. These files control how templates are rendered in the CodePipeline console. For more details on the schema and usage, refer to the [metadata README](templates/metadata/README.md).
- `/cloudformation`: CloudFormation templates for each pipeline configuration.
- `/ui-hints`: JSON files controlling the rendering of template configuration in the CodePipeline console. These files define how the template configuration step is displayed. For more information on the schema and usage, refer to the [UI hints README](templates/ui-hints/README.md).
- `assets`: Contains svg icons for the starter templates
## Development
This project uses Node.js for development tasks. To set up the development environment:
1. Ensure you have Node.js 18 or later installed
2. Run `npm install` to install dependencies
### Adding new templates
To add a new template, follow these steps:
1. Create a new metadata file for the template in the `/templates/metadata` folder. This file should conform to the schema defined in `/templates/metadata/schema.json`.
2. Add the corresponding CloudFormation template file in the `/templates/cloudformation` folder.
3. The build script will automatically validate the metadata and CloudFormation template files, and generate the synthesized files for the CodePipeline Console to render.
### Adding new icons
You are not required to add a new icon for your template. You can use the existing `codepipeline.svg` icon located in the `assets/icons/` folder.
If you want to add a new icon to this package,
1. Add the SVG file to the `assets/icons/` folder in this project.
2. The icon-name in the metadata should correspond to the relevant folder, for example, `icon-name: lambda` expects an icon file at `asset/icons/lambda.svg`.
### Testing your changes
Our [template validation workflow](.github/workflows/validate-templates.yaml) involves JSON schema validation using npm and CloudFormation linting using [cfn-lint](https://github.com/aws-cloudformation/cfn-lint). To test your changes locally:
1. Ensure you have npm and cfn-lint installed on your system.
2. Run the following command to validate the JSON files:
```
npm run test
```
3. Run the following command to validate the CloudFormation files:
```
cfn-lint templates/cloudformation/*
```
## Contributing
We welcome contributions to this project. Please read our [Contributing Guidelines](CONTRIBUTING.md) for more information on how to add new templates or improve existing ones. Your contributions will be available in the CodePipeline Console in a future release.
## Security
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
## License
This project is licensed under the Apache-2.0 License.