Feature Request: Add `author.login` to `context.commit` for Improved Commit Author Identification

Đang mở
#905 4 bình luận 5 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
42/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
github, javascript
Lĩnh vực
release

Hướng nghiên cứu

Bắt đầu bằng cách theo dõi cách plugin semantic-release/github xây dựng context.commit và author object của nó. Kiểm tra các test hiện có liên quan đến commit context, nếu có, sau đó xác minh rằng author.login được expose và có thể được sử dụng trong releaseBodyTemplate example được minh họa mà không làm hỏng các author fields hiện có.

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

Mô tả

Currently, the context.commit object in the semantic-release/github plugin includes the author object with the following properties:

  • author.name: The name of the commit author.
  • author.email: The email of the commit author.
  • author.short: The date of the commit.

While these details are useful, adding the author.login property would be beneficial. The author.login would provide the GitHub/GitLab username of the commit author, allowing for easier association of commits with users in the open-source community.

Use Case:

One practical application of the author.login property is in generating release notes. For example, a releaseBodyTemplate could utilize the author.login to include a more personalized and identifiable reference to contributors as requested in https://github.com/semantic-release/github/issues/805. Here’s a sample config value demo'ing usage...

const releaseBodyTemplate =  `
## Contributors
<% _.forEach(commits, function(commit) { %>
  <img src="https://github.com/<%- commit.author.login %>.png" alt="<%- commit.author.login %>" width="50">
<% }) %>
`;

This addition would enhance the visibility of contributors in release notes and improve the overall attribution process.

Request:

Please consider adding the author.login property to the author object within the context.commit. This enhancement will facilitate better integration with user identities on GitHub/GitLab and improve the generation of release notes and other related tasks.

Ngôn ngữ chính
JavaScript
Star
535
Fork
150
Merge trung bình
1 phút
Pull request đã merge (30 ngày)
3

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

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 semantic-release/github

Tất cả issue của semantic-release/github

Issue tương tự

Thêm issue về JavaScript

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.