ankitects / ankitects/anki

Move proto defs to a dedicated repository managed as git subtree

Open
#4,803 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
31.2k
Forks
3.2k
Avg merge
2d 8h
Merged PRs (30d)
72

Description

continuing from the discord chat. It would be beneficial for downstream projects to be able to track changes to the protobuf definitions. The least painful way to manage this probably via a git subtree, the tl;dr is part of your git tree is copied to a different repo. It's still part of the current repo, it's still included in things like clones, it's just something that can be pushed to independently.

to initialize (assuming anki_proto is the repo name)

git remote add proto_remote https://github.com/ankitecks/anki_proto.git

to push

git subtree push --prefix=proto/ proto_remote main

then projects downstream can track this similarly.

if you initialize the repo, and the necessary token gh side (I just need the name of the secret not the actual secret), I can add a job to the release workflow to conditionally push on change

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 proto/ directory, the linked git subtree guide, and the repository's release workflow. Set up the dedicated repository and its GitHub-side secret as described, then verify that protobuf definitions can be pushed independently and that the release workflow conditionally pushes when proto/ changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
git
Domain
devops, release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.