lowRISC / lowRISC/opentitan

[bazel,openocd] Consider switching to the github mirror instead of sourceforge

Open
#19,643 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
SystemVerilog
Stars
3.6k
Forks
1.1k
Avg merge
2d 22h
Merged PRs (30d)
141

Description

### Description

Sourceforge is not the most reliable platform and the last outage killed our CI for 24h. Since we already rely heavily on github, it would make sense to use [the github official mirror](https://github.com/openocd-org/openocd) instead of sourceforge. This is not trivial though: even though the releases are not on github as well, they are not the same as on github. Specifically:
- the sourceforge release contain the `jimtcl` code and possibly other code included by submodule,
- the github release does not contain this code, *nor* the submodule, essentially making them unusable because the bootstrap script will fail,
- having to run git submodule to boostrap also means that we would have to depend on possibly other sources and is not ideal for airgapped builds?

Possibilities:
- Fork openocd and have our own release action that create an already bootstrapped source code.
- Ask OpenOCD devs to release the same source on sourceforge and github
- (More general) Maintain a download cache in the CI to avoid redownloading things all the time

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 locating the Bazel dependency and bootstrap script that download OpenOCD, then compare the SourceForge and GitHub release archives described in the issue. Determine how submodules and jimtcl affect CI and air-gapped builds, and define whether a mirrored release, an OpenOCD fork, or a download cache is the intended outcome.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
build-system, ci-cd
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.