Chuyển tới nội dung chính

Cấu hình

ReleaseFlow đọc cấu hình từ các biến môi trường RELEASEFLOW_*, được src/main/resources/application.properties ánh xạ sang thuộc tính của Spring. JAR, container image và ./mvnw spring-boot:run đều đọc cùng các biến này. Khoảng thời gian dùng định dạng ISO-8601 (PT10S, P7D), và danh sách cách nhau bởi dấu phẩy.

Chỉ bảng đầu tiên là bắt buộc. Mọi biến khác đều có giá trị mặc định dùng được cho một hệ thống triển khai đơn lẻ trên máy cục bộ.

Bắt buộc​

BiếnLà gì
RELEASEFLOW_DB_URLJDBC URL của một cơ sở dữ liệu PostgreSQL riêng, ví dụ jdbc:postgresql://localhost:5432/releaseflow
RELEASEFLOW_DB_USERNAMENgười dùng cơ sở dữ liệu
RELEASEFLOW_DB_PASSWORDMật khẩu cơ sở dữ liệu
RELEASEFLOW_CREDENTIAL_MASTER_KEYBase64 của đúng 32 byte ngẫu nhiên (openssl rand -base64 32). Nó mã hoá mọi webhook secret, access token và secret của action đã lưu. Ứng dụng không khởi động được nếu thiếu nó, và mất nó thì mọi secret đã lưu đều không đọc được nữa

Không bao giờ commit hay chia sẻ các giá trị này.

Web và phiên đăng nhập​

BiếnMặc địnhTác dụng
RELEASEFLOW_SESSION_COOKIE_SECUREfalseĐánh dấu cookie phiên đăng nhập là Secure; đặt thành true mỗi khi ứng dụng được phục vụ qua HTTPS
RELEASEFLOW_INVITATION_TTLP7DLiên kết mời dùng được trong bao lâu
RELEASEFLOW_UI_LANGUAGESen,viCác ngôn ngữ giao diện được cung cấp; ngôn ngữ đầu tiên là ngôn ngữ dự phòng, và ?lang= chỉ nhận các ngôn ngữ này. Xem Ngôn ngữ giao diện
RELEASEFLOW_OUTPUT_LANGUAGESen,viCác ngôn ngữ đầu ra được gợi ý trong biểu mẫu. Mọi language tag hợp lệ vẫn được chấp nhận. Xem Ngôn ngữ đầu ra
RELEASEFLOW_PUBLIC_BASE_URLhttp://localhost:8080Địa chỉ dùng để truy cập hệ thống triển khai này. Mọi liên kết công khai tuyệt đối đều được dựng từ nó, không bao giờ từ request
RELEASEFLOW_PUBLIC_CHANGELOG_BASE_DOMAIN(trống)Khi được đặt, phục vụ thêm changelog của mỗi Organization tại https://{slug}.{domain}/. Xem Changelog công khai

Nguồn​

BiếnMặc địnhTác dụng
RELEASEFLOW_WEBHOOK_MAX_BODY_BYTES1048576Kích thước lớn nhất của một lần gửi từ bất kỳ nhà cung cấp nào
RELEASEFLOW_GITHUB_API_BASE_URLhttps://api.github.comĐịa chỉ gọi GitHub
RELEASEFLOW_GITHUB_TIMEOUTPT10SThời gian chờ kết nối và đọc với GitHub
RELEASEFLOW_GITLAB_ALLOWED_HOSTSgitlab.comCác instance GitLab mà một nguồn được phép trỏ tới: host, host:port (HTTPS), hoặc một origin đầy đủ như http://gitlab.internal:8080
RELEASEFLOW_GITLAB_TIMEOUTPT5SThời gian chờ kết nối và đọc với GitLab
RELEASEFLOW_GITLAB_WEBHOOK_CLOCK_SKEWPT5MMột lần gửi có chữ ký từ GitLab được phép cũ tới mức nào
RELEASEFLOW_LINEAR_API_BASE_URLhttps://api.linear.appĐịa chỉ gọi GraphQL API của Linear
RELEASEFLOW_LINEAR_TIMEOUTPT5SThời gian chờ kết nối và đọc với Linear
RELEASEFLOW_LINEAR_WEBHOOK_CLOCK_SKEWPT60SwebhookTimestamp của một lần gửi từ Linear, thời điểm Linear gửi đi, được phép lệch khỏi đồng hồ tới mức nào
RELEASEFLOW_JIRA_TIMEOUTPT10SThời gian chờ kết nối và đọc với Jira
RELEASEFLOW_JIRA_POLL_INTERVALPT5MBao lâu đọc mỗi project Jira một lần; nguồn có lần đọc tiếp theo trễ hơn một chu kỳ được hiển thị là quá hạn
RELEASEFLOW_JIRA_POLL_OVERLAPPT10MMỗi lượt đọc lùi lại bao xa so với lượt đọc trước
RELEASEFLOW_JIRA_DESCRIPTION_MAX_CHARACTERS8000Độ dài tối đa của mô tả Jira được giữ làm bằng chứng
RELEASEFLOW_JIRA_API_BASE_URL(trống)Chỉ để thử nghiệm cục bộ: gửi mọi lời gọi Jira tới đây thay vì site của chính nguồn

Xem Nguồn. Tình trạng của một nguồn không có thiết lập riêng: nguồn im lặng được đo trong 90 ngày theo phân vị thứ 90 của các khoảng cách, không bao giờ dưới một giờ và chỉ khi đã có mười khoảng cách, và các lần gửi bị từ chối được ghi khoảng mỗi giây một lần (ADR-0042).

Phân loại​

BiếnMặc địnhTác dụng
RELEASEFLOW_SENSITIVE_PATHSxem bên dướiThay danh sách sensitive path nền. Một mẫu không hợp lệ hoặc danh sách rỗng khiến ứng dụng không khởi động
RELEASEFLOW_CONTEXT_THRESHOLD60Điểm ngữ cảnh (0–100) mà dưới mức đó thay đổi cần review
RELEASEFLOW_DUPLICATE_THRESHOLD0.82Độ tương đồng (0–1) từ mức đó trở lên thì hai thay đổi được ghi nhận là có thể trùng lặp

Danh sách sensitive path nền mặc định là:

text
**/security/**,**/auth/**,**/*Security*,**/*Auth*,**/*Credential*,**/*Password*,
**/db/migration/**,**/*.sql,**/pom.xml,**/package.json,**/package-lock.json,
.github/workflows/**,**/Dockerfile,**/application*.properties,**/*.env*

Xem Thay đổi và review.

AI​

AI không bắt buộc. Chọn một nhà cung cấp và cung cấp key cùng model. Không có model mặc định; chọn một model hỗ trợ đầu ra JSON có cấu trúc.

Với OpenAI hoặc DeepSeek, mọi request phân loại đều dùng cùng một temperature, là 0 trừ khi RELEASEFLOW_AI_TEMPERATURE đặt giá trị khác, giúp câu trả lời cho cùng một thay đổi ổn định nhất trong khả năng của model (xem ADR-0035 và ADR-0038). Model suy luận của OpenAI chỉ nhận temperature mặc định và từ chối request có ghi temperature. Model như vậy vẫn hoạt động mà không cần đặt gì: request bị từ chối được gửi lại một lần nữa không có temperature, và các request sau không gửi temperature cho đến khi ReleaseFlow khởi động lại, kèm một cảnh báo trong log (ADR-0039). Chỉ lỗi 400 có error.param là temperature mới dẫn đến việc này. Một số được đặt ở đây cũng được xử lý như vậy. RELEASEFLOW_AI_TEMPERATURE=default không gửi temperature ngay từ request đầu tiên, nên không có lần từ chối nào.

Với Anthropic, request dùng phiên bản API 2026-10-21, vốn không nhận temperature, nên ReleaseFlow không gửi temperature dù RELEASEFLOW_AI_TEMPERATURE đặt gì, và Claude dùng giá trị mặc định của nó (ADR-0045). Với Claude 4.7 trở về sau, đó vốn là giá trị duy nhất model nhận. Với Claude 4.6 trở về trước, việc phân loại chạy ở temperature mặc định 1.0 thay vì 0, nên câu trả lời cho một thay đổi, và các note viết từ đó, dao động nhiều hơn giữa các lần chạy. Giá trị vẫn được kiểm tra khi khởi động, và một số khác 0 được ghi một cảnh báo trong log rằng nó bị bỏ qua. API key được gửi trong Authorization: Bearer.

BiếnMặc địnhTác dụng
RELEASEFLOW_AI_PROVIDER(trống: không dùng AI)openai, anthropic hoặc deepseek
RELEASEFLOW_AI_TIMEOUTPT60SThời gian tối đa cho mỗi request tới AI
RELEASEFLOW_AI_TEMPERATURE0Temperature của mọi request phân loại tới openai và deepseek: một số từ 0 đến 2; default không gửi temperature, để model dùng giá trị của chính nó. Không đặt hoặc để trống nghĩa là 0. Model từ chối temperature sẽ không được gửi temperature cho đến hết tiến trình. Với anthropic, giá trị phải là một số từ 0 đến 1 hoặc default, và không bao giờ được gửi
RELEASEFLOW_OPENAI_API_KEY, RELEASEFLOW_OPENAI_MODEL(trống)Key và model của OpenAI
RELEASEFLOW_OPENAI_BASE_URLhttps://api.openai.com/v1Địa chỉ API của OpenAI
RELEASEFLOW_ANTHROPIC_API_KEY, RELEASEFLOW_ANTHROPIC_MODEL(trống)Key và model của Anthropic
RELEASEFLOW_ANTHROPIC_BASE_URLhttps://api.anthropic.comĐịa chỉ API của Anthropic. Proxy hoặc gateway ở địa chỉ này nhận key trong Authorization: Bearer và anthropic-version: 2026-10-21
RELEASEFLOW_DEEPSEEK_API_KEY, RELEASEFLOW_DEEPSEEK_MODEL(trống)Key và model của DeepSeek
RELEASEFLOW_DEEPSEEK_BASE_URLhttps://api.deepseek.comĐịa chỉ API của DeepSeek

Ứng dụng không khởi động được khi nhà cung cấp đã chọn thiếu key hoặc model, khi tên nhà cung cấp không hợp lệ, khi key hay model của một nhà cung cấp được đặt trong khi RELEASEFLOW_AI_PROVIDER để trống, hoặc khi RELEASEFLOW_AI_TEMPERATURE không phải default cũng không phải một số trong khoảng của nhà cung cấp đã chọn; thông báo lỗi nêu tên biến và khoảng giá trị. Xem Phân loại và tóm tắt bằng AI.

Dịch thuật​

BiếnMặc địnhTác dụng
RELEASEFLOW_TRANSLATION_PROVIDERdisableddeepl bật tính năng dịch release note. Một giá trị khác disabled và deepl làm ứng dụng không khởi động, và disabled cũng vậy khi RELEASEFLOW_DEEPL_API_KEY đang được đặt
RELEASEFLOW_TRANSLATION_TIMEOUTPT30SThời gian tối đa cho mỗi request dịch
RELEASEFLOW_DEEPL_API_KEY(trống)Key của DeepL; key kết thúc bằng :fx dùng API miễn phí. Bắt buộc với deepl, và một key được đặt khi provider không phải deepl làm ứng dụng không khởi động, nên muốn tắt dịch thì phải xoá cả key. Mỗi Organization có bảng thuật ngữ dùng một glossary của tài khoản DeepL, và gói API Free chỉ có một
RELEASEFLOW_DEEPL_BASE_URL(trống)Ghi đè host được chọn dựa trên key

Xem Ngôn ngữ release note.

Automation​

BiếnMặc địnhTác dụng
RELEASEFLOW_AUTOMATION_TIMEOUTPT10SThời gian tối đa cho mỗi lần gửi ra khỏi ứng dụng
RELEASEFLOW_AUTOMATION_EMAIL_FROM(trống)Địa chỉ người gửi. Thiếu nó và SMTP host thì không bật được action email
RELEASEFLOW_SMTP_HOST(trống)SMTP server
RELEASEFLOW_SMTP_PORT587Cổng SMTP
RELEASEFLOW_SMTP_USERNAME, RELEASEFLOW_SMTP_PASSWORD(trống)Thông tin đăng nhập SMTP
RELEASEFLOW_SMTP_AUTHfalseDùng xác thực SMTP
RELEASEFLOW_SMTP_STARTTLSfalseDùng STARTTLS
RELEASEFLOW_SLACK_ALLOWED_HOSTShooks.slack.com,hooks.slack-gov.comNhững origin duy nhất mà một Slack webhook URL được phép trỏ tới
RELEASEFLOW_NOTION_API_BASE_URLhttps://api.notion.comĐịa chỉ gọi Notion
RELEASEFLOW_NOTION_VERSION2026-03-11Phiên bản Notion API dùng để viết trang. Chỉ đổi nó cùng lúc với body mà ứng dụng gửi đi
RELEASEFLOW_CONFLUENCE_API_BASE_URL(trống)Chỉ để thử nghiệm cục bộ: đứng thay cho Confluence Cloud. Site vẫn được kiểm tra, và liên kết được ghi lại vẫn trỏ tới site đó
RELEASEFLOW_TEAMS_API_BASE_URL(trống)Chỉ để thử nghiệm cục bộ: đứng thay cho Power Platform. Đường dẫn và chữ ký của callback được giữ nguyên
RELEASEFLOW_ZENDESK_API_BASE_URL(trống)Chỉ để thử nghiệm cục bộ: đứng thay cho {subdomain}.zendesk.com. Subdomain vẫn được kiểm tra
RELEASEFLOW_AUTOMATION_TRIGGER_DELAYPT15SBao lâu ReleaseFlow tìm một lần các quy tắc theo lịch hoặc nhắc trước đã đến hạn
RELEASEFLOW_AUTOMATION_TRIGGER_BATCH_SIZE20Mỗi lượt tìm đó được đặt tối đa bao nhiêu lần chạy
RELEASEFLOW_AUTOMATION_REMINDER_LOOKAHEADPT15SMột quy tắc nhắc trước không báo trước chút nào sẽ nhìn trước bao xa
RELEASEFLOW_AUTOMATION_WEBHOOK_CLOCK_SKEWPT5MTimestamp của một lời gọi có chữ ký được phép lệch bao xa so với hiện tại
RELEASEFLOW_AUTOMATION_WEBHOOK_MAX_BODY_BYTES65536Kích thước body lớn nhất của một lời gọi có chữ ký

Action Notion, Confluence, Microsoft Teams hoặc Zendesk không cần gì thêm từ hệ thống triển khai ngoài các giá trị mặc định này: token, URL callback hoặc client secret được nhập riêng cho từng action. Xem Automation.

Cổng quản trị​

BiếnMặc địnhTác dụng
RELEASEFLOW_MANAGEMENT_PORT8081Cổng của endpoint health Actuator và Prometheus
RELEASEFLOW_MANAGEMENT_ADDRESS127.0.0.1Địa chỉ mà cổng đó lắng nghe; chỉ chuyển nó sang một mạng riêng
RELEASEFLOW_MANAGEMENT_HEALTH_MAILfalseĐưa SMTP server vào health, cho hệ thống triển khai không thể hoạt động thiếu email

Xem Vận hành.

Docker Compose và quickstart​

Các biến này được docker-compose.demo.yml và compose.yaml của quickstart đọc, không phải ứng dụng.

BiếnMặc địnhDùng bởiTác dụng
RELEASEFLOW_HTTP_PORT8080cả haiCổng trên máy host của ứng dụng, mở trên 127.0.0.1
RELEASEFLOW_DB_NAMEreleaseflowdemoTên cơ sở dữ liệu
RELEASEFLOW_GRAFANA_USERadmindemoTài khoản quản trị Grafana
RELEASEFLOW_GRAFANA_PASSWORD(bắt buộc)demoMật khẩu quản trị Grafana
RELEASEFLOW_GRAFANA_PORT3000demoCổng trên máy host của Grafana
RELEASEFLOW_PROMETHEUS_PORT9090demoCổng trên máy host của Prometheus
RELEASEFLOW_IMAGE(do bản phát hành ghi vào)quickstartImage, được ghim theo digest mà bản phát hành đã push

Cả hai file Compose chỉ chuyển cho ứng dụng những biến được liệt kê trong .env.example: cơ sở dữ liệu, master key, cookie phiên đăng nhập, changelog công khai, AI (key và model của OpenAI, Anthropic và DeepSeek), DeepL, và SMTP. Mọi biến khác giữ giá trị mặc định của ứng dụng trong các stack đó; để đổi, thêm nó vào environment của service app trong file Compose. Chuyển một giá trị rỗng thay vào đó sẽ khiến ứng dụng dừng, đó là lý do sensitive path, các ngưỡng review và các ngôn ngữ giao diện bị để ngoài. Demo stack còn đặt RELEASEFLOW_MANAGEMENT_ADDRESS=0.0.0.0 bên trong mạng riêng của nó để Prometheus thu thập được số liệu từ ứng dụng, và không mở gì ra ngoài trên cổng đó.

Chỉ dùng khi build và test​

BiếnDùng bởiTác dụng
RELEASEFLOW_VERSION, RELEASEFLOW_REVISIONBuild argument của DockerfilePhiên bản và commit được workflow Release ghi vào image
RELEASEFLOW_E2E_BASE_URLPlaywrightTrỏ bộ test trình duyệt tới một ứng dụng đang chạy sẵn