Skip to content

Commit

Permalink
Merge branch 'main' into docs/faq-updates
Browse files Browse the repository at this point in the history
  • Loading branch information
dericksozo authored Oct 4, 2023
2 parents 2ecc6fc + 230d382 commit 9618a85
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 1 deletion.
44 changes: 44 additions & 0 deletions docs/getting-started/sync-with-aws-codecommit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
id: sync-with-aws-codecommit
title: Sync With AWS CodeCommit
sidebar_label: Sync With AWS CodeCommit
slug: /sync-with-aws-codecommit
pagination_next: getting-started/smart-git-sync
pagination_prev: getting-started/sync-with-bitbucket
---

# Sync With AWS CodeCommit

Amplication allows you to sync the code for your services with AWS CodeCommit repositories.
This provides you with full control over your project and lets you easily track code generated by Amplication.

:::note
The Sync With AWS CodeCommit feature in Amplication is **available exclusively for Enterprise plan users**.
:::

## Prerequisites

To integrate Amplication with AWS CodeCommit, please contact us first and provide the following details during the onboarding:

- **AWS Region**: The AWS region where your CodeCommit repositories are located.
- **AWS HTTPS Git Credentials**: Credentials that allow the `amplication[bot]` user to interact with each CodeCommit git repository. See [Setting Up Git Credentials](https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html) in the AWS documentation for more details.
- **AWS Access Keys**: An Access Key ID and Secret Access Key for an AWS IAM user with the `AWSCodeCommitPowerUser` managed policy. This allows Amplication to manage repository tasks like creating new repositories, making commits, and opening pull requests.

Once you have provided us with this information, Amplication will then integrate with your CodeCommit repositories.

## Selecting a Repository

When you create a new service in Amplication, and select AWS CodeCommit as your git provider, you will have the option to select an existing CodeCommit repository or create a new one.

If you create a new repository, Amplication will automatically create it in your configured AWS account and region.

## Managing Changes

When you make changes in the Amplication editor and commit a new build, Amplication will:

- Create a commit with your changes in the `amplication` branch of your selected repository
- Open a pull request from `amplication` to the default branch (usually `main`)

Read about our [Smart Git Sync](/smart-git-sync) feature to learn how Amplication manages yur git repositories.

You can then review the changes in the AWS CodeCommit console or your preferred Git client before merging them into your default branch.
32 changes: 32 additions & 0 deletions docs/how-to/git-branch-per-service.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: One Git Branch Per Service
sidebar_label: One Git Branch Per Service
slug: /one-git-branch-per-service
pagination_next: getting-started/smart-git-sync
---

# One Git Branch Per Service

With Amplication's Pro Plan, teams can now streamline their workflow in multi-service repositories with **dedicated git branches and PRs for each service**.
This feature enables faster delivery of changes, as only the team members responsible for a specific service need to review the associated PR.

## Benefits

- **Isolated Reviews**: Teams can review changes specific to their services without the interference from other unrelated services.
- **Faster Deployment**: With fewer reviewers needed for each PR, changes can be approved and deployed faster.
- **Cleaner History**: Each service's changes are contained within its branch, leading to a more organized and readable git history.

## How It Works

1. **Automatic Branch Creation**: Whenever a change is made to a service in Amplication, a new branch is automatically created with the naming convention `amplication-serviceName`. If the branch already exists, changes are added to it.
2. **Pull Request Creation**: A PR is created from the `amplication-serviceName` branch to the default branch of the repository. This ensures that every service's changes are isolated and can be reviewed independently.
3. **Integration with Smart Git Sync**: This feature works seamlessly with [Smart Git Sync](/sync-with-github/), ensuring that all changes made in Amplication are reflected in the associated git repository.

## Enable One Git Branch Per Service

To enable the **One Git Branch Per Service** feature, make sure you have subscribed to Amplication's Pro Plan.
As soon as you upgrade, simply continue working on your services, and Amplication will handle the branching and PRs for you.

For more details on how Git sync works in Amplication, refer to the [Smart Git Sync](/sync-with-github/) page.

To learn more about the various features available to you in Amplication's pro plan, visit our [pricing page](https://amplication.com/pricing).
4 changes: 3 additions & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ const sidebars = {
type: "category",
label: "Premium Features",
items: [
"how-to/enterprise-sso"
"how-to/enterprise-sso",
"how-to/git-branch-per-service"
]
},
{
Expand All @@ -67,6 +68,7 @@ const sidebars = {
items: [
"getting-started/sync-with-github",
"getting-started/sync-with-bitbucket",
"getting-started/sync-with-aws-codecommit",
"getting-started/smart-git-sync"
]
},
Expand Down

0 comments on commit 9618a85

Please sign in to comment.