Should source bundle / tarball be published on github?

Open
  • Is something wrong?
#41 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
aws, github
Domain
release

Research direction

Start with the README's release-download reference, then review OpenTTD/nml issue 111 and pull request 113 for the comparable change. Confirm how OpenGFX's generated source bundle is uploaded to S3 and how releases are published; done means the generated bundle is available as a GitHub release asset alongside the documented downloads.

Written by the indexing model from the issue text.

Description

The README refers to github releases for downloading released sources, but that only allows downloading an automatically generated git snapshot.

The generated source bundle is different (includes md5sums, maybe other differences too). This is uploaded to S3 for download through openttd.org (I think), but perhaps it should be uploaded as a release asset to github too?

See https://github.com/OpenTTD/nml/issues/111 and https://github.com/OpenTTD/nml/pull/113 for this same issue and the fix for nml.

Dominant language
JavaScript
Stars
64
Forks
27
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from OpenTTD/OpenGFX

All issues in OpenTTD/OpenGFX

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.