Correct the release checklist's tag and publishing steps

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#68 0 bình luận 0 reaction 1 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@pheus đang làm issue này rồi.

Từ ngày 29/10/2026.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
86/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
git, github-actions, python
Lĩnh vực
documentation, release

Hướng nghiên cứu

Đọc docs/development/releasing.md và so sánh checklist cùng các ví dụ gắn tag hiện có với bốn thay đổi được yêu cầu. Cập nhật hướng dẫn để ghi lại quy tắc triển khai tag v* cho môi trường pypi, quy trình pull request và tag, cùng quy trình hotfix. Hoàn tất khi cả hai ví dụ đều dùng git tag -s và các bước phát hành khớp với issue.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

app: scripts status: accepted type: documentation
Change Type

Correction

Proposed Changes

Update docs/development/releasing.md to match the protected-branch release process.

The current git push origin main vX.Y.Z command can push the tag even when the update to main is rejected. If the release changes are later squash-merged or rebased, that tag can remain on the pre-merge commit.

Please update the guide to:

  • Document a v* deployment rule with ref type Tag for the pypi environment.
  • Prepare release changes on a branch, merge them through a pull request, then tag the resulting commit on main and push only the tag.
  • Bring hotfixes into main through a pull request after publication.
  • Use git tag -s in both tagging examples, consistent with the signed v0.0.1 tag.
Ngôn ngữ chính
Python
Star
8
Fork
0
Merge trung bình
11 giờ 23 phút
Pull request đã merge (30 ngày)
24

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của netbox-community/netbox-scripts

Tất cả issue của netbox-community/netbox-scripts

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.