Integrasi CI/CD

Integrasi Capgo ke dalam pipeline CI/CD Anda memungkinkan Anda untuk otomatisasi sepenuhnya proses pembangunan dan pengiriman update ke aplikasi Anda. Dengan memanfaatkan Capgo CLI dan semantic-release, Anda dapat memastikan pengiriman yang konsisten, dapat diandalkan, dan memungkinkan iterasi cepat.

Manfaat Integrasi CI/CD

• Otomatisasi: Tidak perlu lagi langkah-langkah manual atau kesalahan manusia. Proses pembangunan, pengujian, 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. Ini sangat berharga ketika Anda memiliki beberapa 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 alur kerja CI/CD Anda. Fitur ini menyediakan perintah untuk mengirimkan versi bundle baru, mengelola channel, 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 menyediakan kunci pribadi 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"

Bab berjudul “Mengatur Variabel Lingkungan untuk Pengenkripsi”

For CI/CD environments, it’s recommended to store your private key as an environment variable rather than a file. Here’s how to set it up:

1. Ini menyalin konten kunci ke clipboard Anda.

   cat .capgo_key_v2 | pbcopy

   Tambahkannya ke lingkungan CI/CD Anda:

2. Tambahkan ke lingkungan CI/CD Anda:

   • Aksi GitHub: Tambahkan CAPGO_PRIVATE_KEY ke rahasiaan repositori Anda
   • GitLab CI: Tambahkan sebagai variabel tersembunyi di pengaturan proyek Anda
   • CircleCI: Tambahkan sebagai variabel lingkungan di pengaturan proyek Anda
   • Jenkins: Tambahkan sebagai kredit teks rahasia

3. Pakailah di pipeline Anda:

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

Catatan: The --key-data-v2 Ini perintah untuk 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.

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.

Judul bagian ‘Menyiapkan Capgo di Pipeline CI/CD Anda’

Sementara langkah-langkah yang tepat akan berbeda-beda tergantung pada alat CI/CD yang Anda pilih, proses umum untuk mengintegrasikan Capgo seperti ini:

1. Buatlah kunci API: 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!

2. Konfigurasi bundle upload commandTambahkan langkah ke konfigurasi CI/CD Anda untuk menjalankan bundle upload perintah dengan argumen yang sesuai:

   file upload.yml

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

   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.

3. Tambahkan upload langkah setelah build web AndaPastikan bahwa upload langkah ini datang setelah build web Anda selesai dengan sukses. Hal ini memastikan Anda selalu mengirimkan code terbaru Anda. Berikut adalah contoh konfigurasi untuk GitHub Actions:

   file upload.yml

   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 }}"

Manajemen Versi dengan Semantic-release

Cara yang disarankan untuk mengelola versi dengan Capgo adalah dengan menyetel versi di dalam proyek Anda. capacitor.config.ts Salin ke clipboard package.json:

import pkg from './package.json'

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

Menggunakan semantic-release (atau alat lainnya) untuk memperbarui versi

1. Membangun aplikasi dengan versi yang diperbarui secara otomatis package.json version
2. Bangun aplikasi Anda dengan versi yang diperbarui secara otomatis diintegrasikan
3. Alur kerja CI/CD Anda akan seperti ini:

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 contoh .releaserc konfigurasi file 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}"
      }
    ]
  ]
}

Ini konfigurasi yang melakukan hal berikut:

1. Menganalisis pesan komit untuk menentukan nomor versi berikutnya, mengikuti spesifikasi Conventional Commits.
2. Menghasilkan catatan rilis berdasarkan komit sejak rilis terakhir.
3. Mengupdate CHANGELOG.md file dengan catatan rilis baru.
4. Mengupdate package.json Nomor versi, yang akan diambil oleh konfigurasi capacitor Anda.
5. Mengkomitkan file yang telah diperbarui, CHANGELOG.md, package.jsonserta file lain yang telah berubah kembali ke repository.

Pastikan menjalankan semantic-release sebelum membangun aplikasi Anda agar versi yang diperbarui dari package.json termasuk dalam pembangunan melalui capacitor.config.

Auto-bump ketika versi lokal sudah pada Capgo

Nama Paket harus unik (versi yang dihapus masih mengambil nama mereka). Jika CI terus mengunggah nama yang sama package.json versi, maka proses upload gagal. Lebih baik melakukan bumping package.json (for example with semantic-release). When that is not practical, let the CLI pick the next free semver from the channel’s linked bundle, or else the latest remote app version:

npx @capgo/cli@latest bundle upload --channel=production --auto-bump
npx @capgo/cli@latest bundle upload --auto-bump major
npx @capgo/cli@latest bundle upload --auto-bump minor   # default when the flag has no value
npx @capgo/cli@latest bundle upload --auto-bump patch   # alias: fix
npx @capgo/cli@latest bundle upload --auto-bump metadata
npx @capgo/cli@latest bundle upload --channel=production --auto-bump ai

--auto-bump ai gunakan Capgo Cloudflare AI Workers untuk membandingkan file bundle lokal dengan file delta kanal sebelumnya Capgo major | minor | patch | metadataDengan tidak ada versi sebelumnya Capgo, pembaruan dilakukan secara manual dan tidak melibatkan AI. patch.

Jangan kombinasikan --auto-bump dengan --bundle / -b. Lihat referensi bundle upload reference untuk daftar pilihan lengkap.

Troubleshooting

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

• API kunciPastikan kunci API Anda valid dan memiliki izin yang diperlukan. Jika menggunakan variabel lingkungan, pastikan sudah diatur dengan benar.

• CLI versi: Pastikan Anda menggunakan versi terbaru dari Capgo CLI. Versi lama mungkin memiliki masalah kompatibilitas atau kekurangan fitur tertentu.

• Artikel yang dibangun: 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 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 pengelolaan versi yang tepat dapat mempercepat alur kerja pengembangan Anda. Dengan otomatisasi pengiriman dan pengelolaan versi melalui pendekatan capacitor.config, Anda dapat mengirimkan pembaruan lebih cepat dan dengan lebih percaya diri.

Metode yang disarankan untuk mengatur versi di file capacitor.config.ts dan menggunakan semantic-release untuk memperbarui package.json menyediakan proses pengiriman yang kuat dan dapat diandalkan yang memungkinkan Anda fokus pada pembangunan fitur yang bagus daripada khawatir tentang langkah-langkah rilis manual.

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

Selamat mengembangkan!

Teruskan dari Integrasi CI/CD

Jika Anda menggunakan Integrasi CI/CD Untuk merencanakan otomatisasi CI/CD, hubungkannya dengan Capgo CI/CD Capgo CI/CD untuk alur kerja produk di Capgo CI/CD, Capgo Pembangunan Nadiif untuk alur kerja produk di Capgo Pembangunan Nadiif Capgo Integrasi untuk alur kerja produk dalam Integrasi Capgo untuk alur kerja produk di GitHub Integrasi untuk detail implementasi di GitHub Integrasi Aksi untuk detail implementasi di __CAPGO_KEEP_0__ Aksi Integrasi, dan Untuk detail implementasi di Integrasi CI/CD GitLab.