Page MenuHomePhabricator

contrib: add an extract-electrum.sh script to mirror monorepo commits to github
ClosedPublic

Authored by PiRK on Jul 11 2023, 18:41.

Details

Summary

This will help keep the ElectrumABC github repo up to date, which is needed because we need to push tags there to host the releases. It is also convenient for troubleshooting and git-blaming to have a repository with an uninterrupted git history.

Note that the process does not remove the files that were removed in the [electrum] initial monorepo integration commit (cirrus.yml, pre-commit-config.yaml...). This will have to be done by manually pushing a commit to the github repo, but I don't anticipate it causing any future conflict.

Test Plan

Run the script, check that it works with no rebase conflicts and includes all commits.

cd electrumabc-mirror && git log --pretty=oneline

Compare the electrum directory with the electrumabc-mirror directory with recursive diff or meld. All files not listed in .gitignore should be identical (with the exception of the extra files mentionned in the summary that still need deleting in the github repository)

Diff Detail

Repository
rABC Bitcoin ABC
Branch
extract_electrum
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 24453
Build 48506: Build Diff
Build 48505: arc lint + arc unit

Event Timeline

PiRK requested review of this revision.Jul 11 2023, 18:41
PiRK edited the summary of this revision. (Show Details)
PiRK edited the test plan for this revision. (Show Details)
Fabien requested changes to this revision.Jul 12 2023, 05:36
Fabien added a subscriber: Fabien.

You might want to include the license file and the contributing file as well, otherwise they will disappear. The contributing can be extracted to its own file if needed and linked from the main one.

This revision now requires changes to proceed.Jul 12 2023, 05:36

Good point for the contributing file. I'll create one for Electrum ABC and make sure the links work both in the monorepo and on github after extraction.

Regarding the license file, we could just keep the electrum/LICENSE file permanently. It is low maintenance (not likely to change often), and for now I don't see a good solution for including the COPYING from the root of the monorepo in Electrum ABC source distribution files (via MANIFEST.in)

PiRK edited the summary of this revision. (Show Details)

rebase onto D14259 (add an electrum/CONTRIBUTING.md file)

This revision is now accepted and ready to land.Jul 12 2023, 13:47