Skip to content

🧭 New Onboarding Task for @sjang-bioe #4

Description

@mulatta

🎉 Welcome to the Team!

Hello @{{ github.event.inputs.github_id }}!
This issue will guide you through your onboarding process.
Please follow each step carefully and check off items as you complete them.


🧱 Step 1. Local Setup & Branch Creation

  1. Clone the repository:

    git clone git@github.com:sbee-lab/infra.git
    cd <repo>
  2. Create a new branch:

    git checkout -b onboarding/<your-username>
  3. Add your user configuration:

    • Add entry to:

      • modules/users/students.nix (if role = student)
        or
        modules/users/researchers.nix (if role = researcher)
        or
        modules/users/admins.nix (if role = admin)

        and follow the comments

  4. (Optional) Add an Age key placeholder if needed:

  • If you need access for system/service secrets, add your ssh-age key on pubkeys.json and add your secret perimission in .sops.nix
  • Note that you should update secrets using inv update-sops-files

✅ Step 2. Check and Format

  • Please keep code formatting and check the flake if there's no error
nix fmt
nix flake check

💾 Step 3. Commit and Push

  • Note that your commit should be signed
    see: github docs: signing-commits
  • Also, Commit should be follow the rule below
    ^(feat|fix|docs|style|refactor|test|chore)(\\(.+\\))?: .{1,50}
git add .
git commit -m "feat(users): add user <your-username>"
git push origin onboarding/<your-username>

🔁 Step 4. Create a Pull Request

  1. Go to your fork or the repository on GitHub.

  2. Create a new Pull Request with:

    • Title: feat: onboard <Full Name> (<username>)
    • Description: Reference this issue by adding:
      Closes #<issue-number>
  3. Request a review from your supervisor or the maintainer team. (@mulatta)


🧩 Step 5. Admin Review Checklist

This section is for admins.

  • Review user information and Nix config
  • Verify SSH key
  • Generate age key (if needed)
  • Add age public key to pubkeys.json
  • Update .sops.yaml
  • Re-encrypt secrets
  • Test login & access after deployment

✅ Once all steps are complete and your PR is merged,
we’ll close this issue automatically via Closes #<issue-number> in your PR.

Welcome aboard! 🚀

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions