IQSS / IQSS/dataverse

Feature Request: Let's move the guides.dataverse.org build from Jenkins into GitHub Actions

Open
#12,408 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Feature
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Overview of the Feature Request
Currently, the guides are built by: https://jenkins.dataverse.org/ which uses a .pem to initiate a Sphinx build, log onto the guides server, and unzip it onto the server. The intention is to move away from this process into a more open/controllable build into GitHub Actions. An AWS IAM role could be a possible direction to move away from the pem. This is part of a wider effort by UNC to make Jenkins redundant.

What kind of user is the feature intended for?
(Example users roles: API User, Curator, Depositor, Guest, Superuser, Sysadmin)
Solely intended for community members and developers

What inspired the request?
Organizational mandate from UNC through the Research Data Management Core to retire the Jenkins server.

What existing behavior do you want changed?
The Jenkins build step for Dataverse Guides

Any brand new behavior do you want to add to Dataverse?
Yes, a new GitHub Actions workflow that performs the same build steps.

Any open or closed issues related to this feature request?
N/A

Are you thinking about creating a pull request for this feature?
Yes our organization, The RDMC, (specifically me and @donsizemore) will assume ownership of the feature and the Pull Request if this issue is approved by IQSS maintainers.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing guides build at jenkins.dataverse.org and the contributor information linked in the issue. The work is complete when a GitHub Actions workflow performs the same Sphinx build and deployment steps without the Jenkins build step or its .pem-based process.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, github-actions
Domain
ci-cd, cloud, devops
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.