orf / orf/git-workspace

NixOS `home-manager` module documentation

Open
#333 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
344
Forks
23
PR merge metrics
No merged PRs in 30d

Description

I just submitted this PR that adds a new home-manager module to declaratively set workspaces and create systemd timers to update them.
As soon as it gets (hopefully) merged I think I can rewrite/expand the example in the README.

By the way I'm using this since yesterday and it works great, good job!
Here an example of how the module can be used:


{config, ...}: {
  programs.git-workspace.enable = true;
  services.git-workspace = {
    enable = true;
    frequency = "04:00:00";
    environmentFile = age.secrets.git-workspace-tokens.path; # I use agenix, but one can also directly provide a manually created file
    workspaces = {
      personal.provider = [
        {
          provider = "github";
          name = "aciceri";
          path = "${config.home.homeDirectory}/projects";
          skips_forks = false;
        }
        {
          provider = "github";
          name = "nix-community";
          path = "${config.home.homeDirectory}/nix-community";
        }
      ];
      work.provider = [
        {
          provider = "github";
          name = "company";
          path = "${config.home.homeDirectory}/work" ;
        } 
      ];
    };
  };
}

This generates 2 TOML files for two workspaces (the first one with two providers) and two systemd timers.
I hope I understood how git-workspace was meant to be used correctly and having integrated it well in home-manager but please tell me if I should change something.

Contributor guide

No contributing guide indexed for this repository

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 PR #3811, then inspect the README example for the git-workspace module. Update or expand the example to document the module's workspace and systemd timer configuration, and ensure it matches the merged module behavior.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.