Lewati ke konten utama

Configuration File

Configuration File

Essential

Bedakan packaged initialization source milik Custy dari editable configuration milik project Anda.

Commandcusty init

Category

Configuration

Quick Command

custy init [--mode config] [--ask | --force]

ownershipinitializationsafe replacement

Ringkasan

Custy menyertakan app/templates/config.toml di dalam application package. Saat initialization, Custy menyalin isinya ke .config/custy/config.toml. Pengguna mengedit project copy tersebut dan tidak memerlukan akses ke installed source file.


Ownership

Properties

PropertyTypeDescriptionDefaultRequired
app/templates/config.tomlApplication sourceDikemas bersama Custy dan digunakan untuk membuat project configuration baru. Application upgrade dapat menggantinya.-No
.config/custy/config.tomlProject-owned copyDimuat oleh commands dan ditujukan untuk team-specific edits, review, serta version control.-No
app/templates/changelog/changelog.j2Application sourcePackaged source untuk default changelog layout.-No
.config/custy/templates/changelog/changelog.j2Project-owned copyEditable Jinja template yang dimuat melalui configured path.-No

Packaged dan generated configuration saat ini memiliki logical TOML content yang sama. Byte hash dapat berbeda karena line-ending conversion.


Write Behavior

Workflow Timeline

1
Resource belum ada
Custy membuatnya dari packaged source.
completed
2
Resource sudah ada, normal mode
Custy mempertahankan project copy dan melewati replacement.
current
3
Resource sudah ada dengan --ask
Custy meminta konfirmasi sebelum mengganti setiap file.
pending
4
Resource sudah ada dengan --force
Custy mengganti selected resources tanpa prompt.
pending

TOML Root dan Loading

Required namespace shape
toml
[tool.custy]

[tool.custy.project]
project_source = "auto"

[tool.custy.cli.execution]
dry_run = false
  • Central loader menyediakan values di bawah [tool.custy].
  • Missing configuration diperlakukan sebagai project yang belum diinisialisasi dan memuat empty mapping. Gunakan custy init ketika project-owned defaults diperlukan.
  • Invalid TOML menghasilkan configuration error.
  • Relative paths umumnya dievaluasi dari current working directory.
  • Custy process baru memuat ulang perubahan pada file.
  • Jangan simpan secret values di project configuration. Credential policy dan external token filenames boleh dikonfigurasikan di sana, tetapi isi token harus berada di external credential directory atau environment variable.

Lanjutkan