line / line/centraldogma

Provide an easy way to import a directory into Central Dogma programmatically

Open
#963 6 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue new feature
Dominant language
Java
Stars
668
Forks
135
Avg merge
4d 19h
Merged PRs (30d)
7

Description

A user often needs to import the files in a filesytem into Central Dogma for testing. At the moment, a user need to create a project and a repository, build a commit and push it using the client API. Their life could be simplified a lot by providing the APIs like the following:

public interface CentralDogma {
    // Imports the files in the given directory into Central Dogma.
    // First component in the path becomes the project name.
    // Second component in the path becomes the repository name.
    // e.g. foo/bar/alice.json will create a new project 'foo' and
    //      a new repository 'bar' under the project 'foo', and
    //      add 'alice.json' to the root directory of the repository 'bar'.
    //
    // Placeholder files like '.keep' and '.gitkeep' could be ignored automatically.
    CompletableFuture<ImportResult> importDir(Path dir);
    CompletableFuture<ImportResult> importResourceDir(String dir);
    CompletableFuture<ImportResult> importResourceDir(String dir, ClassLoader classLoader);
}

public interface CentralDogmaRepository {
    // Imports the files in the given directory into the repository.
    // Placeholder files like '.keep' and '.gitkeep' could be ignored automatically.
    CompletableFuture<ImportResult> importDir(Path dir);
    CompletableFuture<ImportResult> importResourceDir(String dir);
    CompletableFuture<ImportResult> importResourceDir(String dir, ClassLoader classLoader);
}

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 with the CentralDogma and CentralDogmaRepository interfaces and compare the proposed importDir and importResourceDir entry points with the existing client API. Clarify how paths map to projects and repositories, how placeholder files are handled, and what ImportResult contains; the work is done when both interfaces support the documented filesystem and resource-directory imports.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.