Blog FOSS by Lê Trung Nghĩa

https://letrungnghia.mangvn.org

Thiết lập sự tích hợp giữa GitHub, Zenodo và ORCID

Setting up the integration between GitHub, Zenodo and ORCID

Theo: https://inbo.r-universe.dev/articles/checklist/zenodo.html

Zenodo là gì?

Được các nhà nghiên cứu xây dựng và phát triển để đảm bảo rằng bất kỳ ai cũng có thể tham gia vào Khoa học Mở.

Dự án của OpenAIRE, tiên phong trong các phong trào truy cập mở và dữ liệu mở ở châu Âu đã được Ủy ban châu Âu ủy quyền để hỗ trợ cho chính sách Dữ liệu Mở non trẻ của họ bằng việc cung cấp một kho lưu trữ nắm bắt toàn bộ cho nghiên cứu được Ủy ban châu Âu cấp vốn. CERN, và OpenAIRE đối tác và tiên phong trong nguồn mở, truy cập mở và dữ liệu mở, đã cung cấp khả năng này và Zenodo đã được khởi xướng vào tháng 5/2013 (Tổ chức của châu Âu về Nghiên cứu Hạt nhân - CERN và OpenAIRE 2013).

Để hỗ trợ cho chương trình nghiên cứu của mình, CERN đã phát triển các công cụ cho quản lý Dữ liệu Lớn (Big Data) và đã mở rộng các khả năng của Thư viện Số cho Dữ liệu Mở. Thông qua Zenodo các công cụ Khoa học Lớn đó có thể được chia sẻ hiệu quả với cái đuôi dài của nghiên cứu.

Việc xuất bản gói mã nguồn qua Zenodo có vài lợi ích.

  • Mã được lưu trữ không mất tiền.

  • Mã vẫn là sẵn sàng công khai, thậm chí nếu kho GitHub bị loại bỏ.

  • Mã có một DOI, là để dễ dàng hơn để trích dẫn mã và theo dõi các trích dẫn. Mỗi phiên bản có phát hành riêng của nó và có một DOI dành riêng luôn trỏ tới phiên bản mới nhất. Điều này trao cho người sử dụng sự lựa chọn giữa việc trích dẫn toàn bộ mã hoặc một phiên bản nhất định.

ORCID là gì?

ORCID là các ký tự đầu của Open Researcher and Contributor ID, có nghĩa là Mã nhận diện của Người đóng góp và Nhà nghiên cứu Mở, là một tổ chức toàn cầu, không vì lợi nhuận được duy trì bằng các khoản phí từ các tổ chức thành viên của họ. Tổ chức này được cộng đồng xây dựng nên và được đại diện Ban Giám đốc của các thành viên của họ với sự đại diện của nhiều bên liên quan điều hành. ORCID được các nhân viên chuyên nghiệp chuyên tâm và tinh thông hỗ trợ.

Các nhà nghiên cứu riêng lẻ là tâm điểm của mọi điều ORCID làm và sẽ luôn có quyền truy cập tới các hồ sơ và dữ liệu của họ tự do không mất tiền. Nếu bạn chưa có một Mã nhận diện ORCID, hãy đăng ký hôm nay! Các nhà nghiên cứu có thể nhận diện bản thân bằng Mã nhận diện ORCID này trong các xuất bản phẩm của họ. Điều này hóa giải được sự mù mờ tiềm tàng vì vài người có cùng tên hoặc cách đánh vần khác nhau tên của các nhà nghiên cứu.

ORCID cung cấp cho các nhà nghiên cứu cách thức dễ dàng để xuất bản một danh sách xuất bản trong hồ sơ ORCID của họ. Nhà nghiên cứu có thể bổ sung thêm một cách thủ công các xuất bản phẩm vào hồ sơ này. ORCID có các kết nối với vài nhà cung cấp dữ liệu (ví dụ, các nhà xuất bản, Zenodo). Các nhà nghiên cứu có thể thiết lập ORCID và bổ sung thêm các xuất bản phẩm mới một cách tự động tới hồ sơ của họ. Điều này làm dễ dàng hơn để duy trì và cập nhật danh sách các xuất bản phẩm.

Vì sao tích hợp Zenodo và ORCID với GitHub?

Việc thiết lập sự tích hợp có lợi là một phiên bản mới của gói tự động có mã DOI độc nhất và được thêm vào hồ sơ ORCID của bạn.

Thiết lập ORCID

Một lần

  1. Tạo một tài khoản tại https://orcid.org

  2. Đi tới DataCite và chọn “Sign in” (Đăng nhập).

  3. Chọn “Sign in with Globus”, sau đó “Sign in with ORCID iD”.

  4. Cho phép truy cập tới Globus Auth.

Thiết lập Zenodo

Một lần

  1. Tạo tài khoản, sử dụng ORCID của bạn tại https://zenodo.org/signup/

Một lần cho mỗi kho lưu trữ

  1. Đăng nhập tới Zenodo.

  2. Đi tới hội combo có liên quan tới tài khoản của bạn (trên đỉnh phái bên phải) và chọn GitHub.

  3. Tìm kho lưu trữ trong danh sách các kho. Sử dụng núm “Sync now” (Đồng bộ) nếu bạn không tìm ra kho đó. Lưu ý là bạn chỉ có thể sử dụng các kho công khai.

  4. Bật kho đó thành “On”.

Điều gì xảy ra tiếp theo?

  1. Đảm bảo rằng bạn đã thiết lập mã của bạn như một gói với hỗ trợ checklist. Xem vignette("getting_started", package = "checklist") về cách làm điều đó như thế nào.

  2. Thêm ORCID của tất cả những người đóng góp vào DESCRIPTION.

  3. Đẩy các yêu cầu đăng (commits) mới tới GitHub kích hoạt một hành động của GitHub chạy check_package(). Điều này đảm bảo rằng thông tin trích dẫn trong CITATION, CITATION.cff.zenodo.json sẽ được cập nhật. Zenodo sử dụng điều sau như là siêu dữ liệu cho DOI mới.

  4. Trộn một yêu cầu kéo (pull request) tới nhánh chính sẽ kích hợp một tiến trình Hành động của GitHub để bổ sung thêm một thẻ mới với số phiên bản. Điều này làm cho phiên bản của gói đó có thể thiết lập được với remotes::install_github("organisation/package@tag") (thay thế organisation, packagetag bằng các giá trị phù hợp). Thẻ đó là “v” theo sau là số phiên bản (ví dụ, v0.5.2).

  5. Bổ sung thêm thẻ kích hoạt tiến trình Hành động của GitHub để tạo ra một phát hành mới. Nội dung liên quan tới NEWS.md trở thành mô tả của phát hành đó.

  6. Zenodo dò ra phát hành mới, tạo một DOI và xuất bản nó.

  7. Zenodo truyền siêu dữ liệu trích dẫn sang ORCID cho tất cả những người đóng góp với một ORCID được liệt kê trong DESCRIPTION. ORCID bổ sung thêm thông tin xuất bản tới những người sử dụng đã thêm sự tích hợp của DataCite.

Tổ chức của châu Âu về Nghiên cứu Hạt nhân, và OpenAire. 2013. “Zenodo.” CERN. https://doi.org/10.25495/7GXK-RD71.

What is Zenodo?

Built and developed by researchers, to ensure that everyone can join in Open Science.

The OpenAIRE project, in the vanguard of the open access and open data movements in Europe was commissioned by the EC to support their nascent Open Data policy by providing a catch-all repository for EC funded research. CERN, an OpenAIRE partner and pioneer in open source, open access and open data, provided this capability and Zenodo was launched in May 2013 (European Organization For Nuclear Research and OpenAIRE 2013).

In support of its research programme CERN has developed tools for Big Data management and extended Digital Library capabilities for Open Data. Through Zenodo these Big Science tools could be effectively shared with the long-tail of research.

Publishing the package code through Zenodo has several benefits.

  • The code is archived free of charge.

  • The code remains publicly available, even if the GitHub repository is removed.

  • The code gets a DOI, making it easier to cite the code and track the citations. Every release gets its own release and there is a dedicated DOI which always points at the latest release. This gives the user a choice between citing the code in general or a specific version.

What is ORCID?

ORCID, which stands for Open Researcher and Contributor ID, is a global, not-for-profit organization sustained by fees from their member organizations. They are community-built and governed by a Board of Directors representative of their membership with wide stakeholder representation. ORCID is supported by a dedicated and knowledgeable professional staff.

Individual researchers are the heart of everything ORCID does and will always have access to their records and data for free. If you don’t already have an ORCID iD, register for one today! Researchers can identify themselves with this ORCID iD in their publications. This solves potential ambiguity dues to several persons with the same name or different spellings of a researchers name.

ORCID provides researchers an easy way to publish a list of publication on their ORCID profile. The researcher can manually add publications to this profile. ORCID has links with several data providers (e.g. publishers, Zenodo). The researchers can setup ORCID to add new publications automatically to their profile. This makes it easier to maintain an updated list of publications.

Why integrate Zenodo and ORCID with GitHub?

Setting up the integration has the benefit that a new package version automatically gets a unique DOI and is added to your ORCID profile.

Setup ORCID

Once

  1. Create an account at https://orcid.org

  2. Go to DataCite and select “Sign in”.

  3. Select “Sign in with Globus”, then “Sign in with ORCID iD”.

  4. Authorise access to Globus Auth.

Setup Zenodo

Once

  1. Create an account using your ORCID at https://zenodo.org/signup/

Once per repository

  1. Log-in to Zenodo.

  2. Go the to drop-down box associated to your account (top right) and choose GitHub.

  3. Find the repository in the list of repositories. Use the “Sync now” button if you can’t find the repository. Note that you can only use public repositories.

  4. Flip the switch of the repository to “On”.

What happens next?

  1. Make sure that you’ve set-up your code as a package with checklist support. See vignette("getting_started", package = "checklist") on how to do that.

  2. Add the ORCID of all contributors to the DESCRIPTION.

  3. Pushing new commits to GitHub triggers a GitHub action that runs check_package(). This makes sure that the citation information in CITATION, CITATION.cff and .zenodo.json are up to date. Zenodo uses the latter as meta data for the new DOI.

  4. Merging a pull request to the main branch will trigger a GitHub Action workflow that adds a new tag with the version number. This makes that version of the package installable with remotes::install_github("organisation/package@tag") (replace organisation, package and tag with the appropriate values). The tag is “v” followed by the version number (e.g. v0.5.2).

  5. Adding the tag triggers another GitHub Action workflow that creates a new release. The relevant content of the NEWS.md becomes the description of the release.

  6. Zenodo detects the new release, creates a DOI and publishes it.

  7. Zenodo passes the citation metadata to ORCID for all contributors with an ORCID listed in DESCRIPTION. ORCID adds the publication information to the users which have added the DataCite integration.

European Organization For Nuclear Research, and OpenAIRE. 2013. “Zenodo.” CERN. https://doi.org/10.25495/7GXK-RD71.

Dịch: Lê Trung Nghĩa

letrungnghia.foss@gmail.com

Tác giả: Nghĩa Lê Trung