endless-sky/Endless-Sky-Delta

[Request] GitHub build of Endless Ships from within Endless Sky Delta release process

Open

#88 opened on Oct 1, 2024

View on GitHub
 (5 comments) (1 reaction) (0 assignees)C++ (2 forks)github user discovery
documentationhelp wanted

Repository metrics

Stars
 (18 stars)
PR merge metrics
 (PR metrics pending)

Description

Problem Description

7even has a wonderful pair of websites in the form of:

The first is a database of ships and outfits of the odd(unstable) versions of Endless Sky, and the later is the same except for the even(stable) versions of Endless Sky.

I would love to have such a page for Endless Sky Delta, it would make an excellent reference for us.

Related Issue Links

n/a

Desired Solution

Ideally, I would like something integrated into the release build process that runs Endless Ships to generate an additional artifact in the form of a complete website that we can upload somewhere.

Even better would be if it would automatically uploaded to a site or page.

Alternative Approaches

Unknown. Alternatives welcome.

Additional Context

7even has done some work to enable Endless Ships to be build both locally and via Docker, and has talked about using NPM. I am unfamiliar with all of these, so my hope is that someone who is more familiar with building in a linux environment and/or any of these container formats and/or github builds will be able to figure out how to do it here.

Contributor guide

Research direction
Familiarize yourself with the current release process in the repository. Then, examine the Endless Ships repository (likely external) to understand how to build it via Docker and npm. Implement a GitHub Actions workflow that runs Endless Ships during release to generate the website artifact and optionally deploy it.
Tech stack
dockernodejsgithub actions
Domain
devopsbuild system
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
DockerGitHub Actionsnpm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40