Integrasi CI/CD

Menyalin prompt pengaturan dengan langkah instalasi dan panduan markdown lengkap untuk plugin ini.

Dengan mengintegrasikan Capgo ke dalam pipeline CI/CD Anda, Anda dapat memastikan proses pembangunan dan pengiriman update aplikasi Anda dapat diotomatisasi secara penuh. Dengan memanfaatkan Capgo CLI dan semantic-release, Anda dapat memastikan pengiriman yang konsisten dan dapat diandalkan serta memungkinkan iterasi yang cepat.

Keuntungan Integrasi CI/CD

Automasi: Tidak perlu lagi langkah-langkah manual atau kesempatan kesalahan manusia. Proses build, test, dan pengiriman Anda dapat diotomatisasi dari awal hingga akhir.
Konsistensi: Setiap pengiriman mengikuti langkah-langkah yang sama, sehingga proses yang dapat diprediksi dan dapat diulang. Hal ini sangat berharga ketika Anda memiliki anggota tim yang berkontribusi code.
Iterasi yang lebih cepat: Dengan pengiriman otomatis, Anda dapat mengirimkan update lebih sering dan dengan percaya diri. Tidak perlu lagi menunggu QA manual atau persetujuan rilis.

Capgo CLI

Capgo CLI adalah kunci untuk mengintegrasikan Capgo ke dalam workflow CI/CD Anda. Ini menyediakan perintah untuk mengirimkan versi bundle baru, mengelola saluran, dan lain-lain.

Perintah yang paling penting untuk integrasi CI/CD adalah bundle upload:

npx @capgo/cli@latest bundle upload --channel Production --apikey YOUR_API_KEY

Jika Anda menggunakan enkripsi, Anda harus menyediakannya dari salah satu cara berikut:

Menggunakan jalur file kunci pribadi:

npx @capgo/cli@latest bundle upload --channel Production --apikey YOUR_API_KEY --key-v2 PRIVATE_KEY_PATH

Menggunakan konten kunci pribadi secara langsung (direkomendasikan untuk CI/CD):

npx @capgo/cli@latest bundle upload --channel Production --apikey YOUR_API_KEY --key-data-v2 PRIVATE_KEY_CONTENT

Menggunakan variabel lingkungan (praktik terbaik untuk CI/CD):

npx @capgo/cli@latest bundle upload --channel Production --apikey YOUR_API_KEY --key-data-v2 "$CAPGO_PRIVATE_KEY"

Mengatur Variabel Lingkungan untuk Pengenkripsi

Untuk lingkungan CI/CD, disarankan untuk menyimpan kunci pribadi sebagai variabel lingkungan daripada file. Berikut cara mengaturnya:

Ambil kunci pribadi Anda:
Jendela terminal
```
cat .capgo_key_v2 | pbcopy
```
Ini akan menyalin konten kunci ke papan klip Anda.
Tambahkan ke lingkungan CI/CD Anda:
- GitHub Aksi: Tambahkan CAPGO_PRIVATE_KEY ke rahasia repository Anda
- GitLab CI: Tambahkan sebagai variabel tersembunyi di pengaturan proyek Anda
- CircleCI: Tambahkan sebagai variabel lingkungan di pengaturan proyek Anda
- Jenkins: Masukkan sebagai teks kunci

Gunakan di dalam pipeline Anda:

- run: npx @capgo/cli@latest bundle upload --channel=production --apikey=${{ secrets.CAPGO_API_KEY }} --key-data-v2 "${{ secrets.CAPGO_PRIVATE_KEY }}"

Catatan: Bendera ini memungkinkan Anda untuk memasukkan konten kunci pribadi secara langsung sebagai string, sehingga sangat cocok untuk variabel lingkungan di pipeline CI/CD di mana Anda tidak ingin membuat file sementara. --key-data-v2 Perintah ini mengunggah build web saat ini ke saluran yang ditentukan. Anda biasanya menjalankan perintah ini sebagai langkah terakhir di pipeline CI/CD Anda, setelah build web Anda telah selesai dengan sukses.

Mengatur __CAPGO_KEEP_0__ di Pipeline CI/CD Anda

Bagian berjudul “Mengatur Capgo di Pipeline CI/CD Anda”

Buatlah kunci Capgo

Generate an API key: Masuk ke dashboard Capgo dan buat kunci baru API. Kunci ini akan digunakan untuk mengautentikasi CLI di lingkungan CI/CD Anda. Jaga rahasia dan jangan pernah komitnya ke repositori Anda!
Konfigurasi bundle upload perintah: Tambahkan langkah ke konfigurasi CI/CD Anda yang menjalankan bundle upload perintah dengan argumen yang tepat:
upload.yml
```
- run: npx @capgo/cli@latest bundle upload --channel=production --apikey=${{ secrets.CAPGO_API_KEY }}
```
\n Ganti Production dengan saluran yang ingin Anda buat, ${{ secrets.CAPGO_API_KEY }} dengan variabel lingkungan yang menyimpan kunci API Anda, dan tambahkan --key-data-v2 "${{ secrets.CAPGO_PRIVATE_KEY }}" jika menggunakan enkripsi.

Tambahkan upload langkah setelah pembangunan web Anda: Pastikan bahwa 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

name: Deploy to Capgo
 on:
  push:
   branches: [main]

jobs:
 deploy:
 runs-on: ubuntu-latest

 steps:
 - uses: actions/checkout@v6
 - uses: actions/setup-node@v6
  with:
   node-version: '24'

 - run: npm ci
 - run: npm run build

 - run: npm install -g @capgo/cli
 - run: npx @capgo/cli@latest bundle upload --channel=production --apikey=${{ secrets.CAPGO_API_KEY }} --key-data-v2 "${{ secrets.CAPGO_PRIVATE_KEY }}"

Salin ke clipboard

The recommended way to handle versioning with Capgo is to set the version in your capacitor.config.ts Cara yang disarankan untuk mengelola versi dengan __CAPGO_KEEP_0__ adalah dengan menetapkan versi di file Anda dengan mengimportnya dari package.json:

import pkg from './package.json'

const config: CapacitorConfig = {
  // ... other config
  plugins: {
    CapacitorUpdater: {
      version: pkg.version,
    }
  }
}

Dengan cara ini Anda dapat:

Menggunakan semantic-release (atau alat lainnya) untuk memperbarui versi package.json versi
Buat aplikasi Anda dengan versi yang diperbarui secara otomatis termasuk
Unggah bundle dengan versi yang benar

Alur kerja CI/CD Anda akan seperti ini:

- run: npm ci
- run: npx semantic-release  # Updates package.json version
- run: npm run build         # Builds with new version from capacitor.config
- run: npx @capgo/cli@latest bundle upload --channel=production --apikey=${{ secrets.CAPGO_API_KEY }}

Berikut adalah contoh .releaserc file konfigurasi untuk semantic-release:

{
  "branches": [
    "main",
    {
      "name": "beta",
      "prerelease": true
    }
  ],
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    "@semantic-release/changelog",
    [
      "@semantic-release/git",
      {
        "assets": ["CHANGELOG.md", "package.json"],
        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
      }
    ]
  ]
}

Konfigurasi ini melakukan hal-hal berikut:

Menganalisis pesan komit untuk menentukan nomor versi berikutnya, mengikuti spesifikasi Conventional Commits.
Menghasilkan catatan rilis berdasarkan komit sejak rilis terakhir.
Mengupdate CHANGELOG.md file dengan catatan rilis baru.
Mengupdate package.json versi, yang akan diambil oleh konfigurasi capacitor Anda.
Mengkomitkan file-file yang telah diperbarui, serta file lain yang telah berubah, kembali ke repository. CHANGELOG.md, package.jsonPastikan Anda menjalankan semantic-release sebelum membangun aplikasi Anda agar versi yang diperbarui dari __CAPGO_KEEP_0__ termasuk dalam build melalui konfigurasi __CAPGO_KEEP_0__ Anda.

Pengaturan package.json is included in your build through the capacitor.config.

Jika Anda mengalami masalah dengan integrasi CI/CD __CAPGO_KEEP_0__ Anda, beberapa hal yang perlu Anda periksa:

: Pastikan kunci Capgo Anda valid dan memiliki izin yang diperlukan. Jika menggunakan variabel lingkungan, pastikan Anda memeriksa bahwa sudah terkonfigurasi dengan benar.

API key: Ensure your API key is valid and has the necessary permissions. If using an environment variable, double check that it’s set correctly.
Versi CLI: Pastikan Anda menggunakan versi terbaru dari Capgo CLI. Versi yang lebih tua mungkin memiliki masalah kompatibilitas atau kekurangan fitur tertentu.
Artefak Pembangunan: Pastikan bahwa pembangunan web Anda menghasilkan file keluaran yang diharapkan. Capgo CLI membutuhkan pembangunan web yang valid untuk membuat bundle.
Koneksi Jaringan: Periksa bahwa lingkungan CI/CD Anda memiliki akses ke server Capgo. Masalah firewall atau proxy dapat mengganggu koneksi ke server. upload Perintah

: Jika Anda masih mengalami masalah, hubungi Capgo untuk mendapatkan bantuan. Mereka dapat membantu menyelesaikan masalah dengan konfigurasi spesifik Anda.

Kesimpulan

Integrasi Capgo ke dalam pipeline CI/CD Anda dengan manajemen versi yang tepat dapat mempercepat alur kerja pengembangan Anda. Dengan otomatisasi pengiriman dan versi melalui pendekatan capacitor.config, Anda dapat mengirimkan pembaruan dengan lebih cepat dan percaya diri.

Metode yang Direkomendasikan untuk Mengatur Versi di capacitor.config.ts file dan menggunakan semantic-release untuk memperbarui package.json menawarkan proses pengembangan yang kuat dan dapat diandalkan yang memungkinkan Anda fokus pada pembangunan fitur-fitur yang bagus daripada khawatir tentang langkah-langkah rilis manual.

Untuk informasi lebih lanjut tentang perintah dan opsi Capgo CLI , silakan cek di CLI referensi. Dan untuk memahami lebih dalam tentang pengaturan semantic-release, lihat docs semantic-release.

Selamat mengembangkan!