You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/docs/docs/getting-started/cicd-integration.mdx
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,10 +21,10 @@ Integrating Capgo into your CI/CD pipeline allows you to fully automate the proc
21
21
22
22
The Capgo CLI is the key to integrating Capgo into your CI/CD workflow. It provides commands for pushing new bundle versions, managing channels, and more.
23
23
24
-
The most important command for CI/CD integration is `upload`:
24
+
The most important command for CI/CD integration is `bundle upload`:
This command uploads the current web build to the specified channel. You'll typically run this as the last step in your CI/CD pipeline, after your web build has completed successfully.
@@ -36,9 +36,9 @@ While the exact steps will vary depending on your CI/CD tool of choice, the gene
36
36
<Steps>
37
37
1.**Generate an API key**: Log in to the Capgo dashboard and create a new API key. This key will be used to authenticate the CLI in your CI/CD environment. Keep it secret and never commit it to your repository!
38
38
39
-
3.**Configure the `upload` command**: Add a step to your CI/CD configuration that runs the `upload` command with the appropriate arguments: <Codelang="yaml"title="upload.yml"code={`- run: npx @capgo/cli@latest upload --channel=Production --apikey=$\{\{ secrets.CAPGO_API_KEY \}\}`} />\n Replace `Production` with the channel you want to deploy to, and `${{ secrets.CAPGO_API_KEY }}` with the environment variable holding your API key.
39
+
3.**Configure the `bundle upload` command**: Add a step to your CI/CD configuration that runs the `bundle upload` command with the appropriate arguments: <Codelang="yaml"title="upload.yml"code={`- run: npx @capgo/cli@latest bundle upload --channel=Production --apikey=$\{\{ secrets.CAPGO_API_KEY \}\}`} />\n Replace `Production` with the channel you want to deploy to, and `${{ secrets.CAPGO_API_KEY }}` with the environment variable holding your API key.
40
40
41
-
4.**Add the `upload` step after your web build**: Ensure that the `upload` step comes after your web build has completed successfully. This ensures you're always deploying your latest code.\n Here's an example configuration for GitHub Actions:\n<Codelang="yaml"title="upload.yml"code={`name: Deploy to Capgo\n on:\n push:\n branches: [main]\n\njobs:\n deploy:\n runs-on: ubuntu-latest\n\n steps:\n - uses: actions/checkout@v3\n - uses: actions/setup-node@v3\n with:\n node-version: 18\n\n - run: npm ci\n - run: npm run build\n\n - run: npm install -g @capgo/cli\n - run: npx @capgo/cli@latest upload --channel=Production --apikey=$\{\{ secrets.CAPGO_API_KEY \}\}`} />
41
+
4.**Add the `upload` step after your web build**: Ensure that the `upload` step comes after your web build has completed successfully. This ensures you're always deploying your latest code.\n Here's an example configuration for GitHub Actions:\n<Codelang="yaml"title="upload.yml"code={`name: Deploy to Capgo\n on:\n push:\n branches: [main]\n\njobs:\n deploy:\n runs-on: ubuntu-latest\n\n steps:\n - uses: actions/checkout@v3\n - uses: actions/setup-node@v3\n with:\n node-version: 18\n\n - run: npm ci\n - run: npm run build\n\n - run: npm install -g @capgo/cli\n - run: npx @capgo/cli@latest bundle upload --channel=Production --apikey=$\{\{ secrets.CAPGO_API_KEY \}\}`} />
42
42
43
43
</Steps>
44
44
@@ -64,7 +64,7 @@ Here's a sample `.releaserc` configuration file for semantic-release:
@@ -83,10 +83,10 @@ This configuration does the following:
83
83
1. Analyzes commit messages to determine the next version number, following the Conventional Commits spec.
84
84
2. Generates release notes based on the commits since the last release.
85
85
3. Updates the `CHANGELOG.md` file with the new release notes.
86
-
4. Runs the Capgo CLI `upload` command, passing the new version number and using the `--partial` flag for differential updates.
86
+
4. Runs the Capgo CLI `bundle upload` command, passing the new version number and using the `--partial` flag for differential updates.
87
87
5. Commits the updated `CHANGELOG.md`, `package.json`, and any other changed files back to the repository.
88
88
89
-
To use semantic-release with Capgo, simply add a step to your CI/CD configuration that runs `npx semantic-release`. Ensure this step comes after your web build and before the Capgo `upload` step.
89
+
To use semantic-release with Capgo, simply add a step to your CI/CD configuration that runs `npx semantic-release`. Ensure this step comes after your web build and before the Capgo `bundle upload` step.
0 commit comments