Tutorials#

Guided paths through the things people do on their first day. Each one is a few minutes; every step links to the full documentation.

Ship your first change#

The shortest path from "new account" to "merged code":

1. Create an account and add an SSH key.
2. Create a repository — or import an existing one from GitHub or GitLab.
3. Push your code — the exact clone and push commands are on the page.
4. Open a merge request from a branch and ask a teammate for a review.
5. When it is approved and green, merge it.

Then make it yours: add a README, protect main with required approvals, and cut your first release from a tag.

Publish a container image from CI#

1. Log in once locally with a personal access token and push an image by hand, to see the naming and visibility rules work.
2. Add a workflow that builds the image — in CI there is no login step: every job is pre-logged-in with a per-job token (details).
3. Pushing a brand-new image name needs permissions: packages: write in the workflow — the first push claims the name for your repository.
4. For the machines that will pull it, mint a pull-only deploy token instead of handing out a human's credentials.

The migration guide's registry section shows the same workflow if you are coming from GHCR.

Move a project over from GitHub#

1. Import the repository — code, issues and pull requests come across with numbers and authors preserved. Give the import a token if the repo is large or private.
2. Leave .github/workflows/ exactly as it is — rickub reads those files unchanged. Push and watch the first run.
3. Re-create your secrets by hand — the one thing that does not travel with a push — renaming anything that starts with GITHUB_ or RICKUB_.
4. Audit the differences that can bite a migrated pipeline: environment: is ignored, and GITHUB_TOKEN is valid here only. Both are covered, with the workarounds, in What's different.
5. Point image pushes at registry.rickub.com — no login step — or keep GHCR with your own PAT as a secret.