Contributor Roles

There are 3 project roles in Anuket:

1. Project Technical Leads (PTLs) - In charge of the technical direction of the project (also defined as a committers)

2. Committers - Write, review, and approve changes to the project

3. Contributors - Write and review changes to the project

To maintain these roles in Gitlab the following structure is in place:

• The default branch (master or main) is protected, and requires CODEOWNER approval

  to merge changes.

• Committers are listed in the CODEOWNERS file as reviewers for all files

  CODEOWNERS

  * @committer1 @committer2 ...

• Everyone else is considered a contributor.

• All active contributors (including committers) are given Developer

  level permissions on the Anuket group.

    Note: Users are not granted Maintainer rights as that would allow them to remove branch protections, force push, and modify license policies. Some maintainer
   capabilities will be available to developers through the LFX project control center at a future date.

Contribution Process

There are two main workflows when contributing code on GitLab: branching and forking. Which one you use will depend on your need and level of access to a project. In all
cases the fork workflow is preferred.

The first step is to create a GitLab account. You'll need to have verify your account with a credit card before CI jobs can be ran in your personal or project forks.
If you'd prefer not to have to add a credit card you can click "Request Access" on the Anuket group, after creating an account. Once your access is approved, you can utilize CI through merge
requests (MRs) against Anuket projects.

GitLab Fork Workflow

1. Fork the project

   1. After logging in, click on the "Fork" link at the top right of the project page.

      

   2. Specify the Project name, Group (or user account) the project should be under, and the name for the fork as Project slug. Set the Visibility level to Public, and click "Fork project"

      

2. Setup mirroring - This will keep the project's default branch up-to-date in your fork so you can always start your work from the most recent changes to the project.

   Alternatively you may manage this yourself by adding an extra 'upstream' git remote pointed at the original project, and routinely running 'git pull upstream/master','git push origin master' to update your fork.

   1. Open Settings → Repository from the project sidebar.

      

   2. Expand the "Mirroring repositories" section

      

   3. Enter the Git Repository URL starting with https://gitlab.com/anuket and ending with /<project>.git

      

   4. Check "Mirror only

      

3. Clone your fork

   There is a "Clone" drop down on the fork project page which provides git URLs to clone over SSH or HTTPS (to be passed to git clone) or magic links to clone the project through Visual Studio Code.

   

4. Checkout a new branch to make your change

   git checkout -b <mybranchname>

5. Edit the code, stage the changes (git add), and commit them to your branch

   Remember to include a 'Signed-off-by' line on your commits ( git commit -s if on the command line).
   

   1. In the UI: If you're going to be making more than one commit, uncheck 'Start a new merge request with these changes'

      

6. Push the branch to your fork

7. There will be a link returned in the console from running git push, which when clicked will automatically open a merge request to the upstream project.

   You can also create the merge request manually from the Merge Request page of your fork.
   

8. Fill out the details of your merge request.

   If you have multiple commits, write a detailed explanation about what you're asking to be merged in. You can also add "Draft: " to the title to signal that changes are still being made.

9. Wait for CI to pass and a committer (identified by the CODEOWNERS file) to review and merge.

   

   If the project is utilizing hardware for their CI, a developer will need to approve your pipeline to run before it is tested.

GitLab Branch Workflow

1. Clone the project

2. edit, git add, commit

   Write you change (remember to include `-s` to sign off commits: `git

   commit -s`)

3. git push

4. Click the link from the message to open a merge request to the repository

5. If you have multiple commits, write a detailed explanation about what you're asking to be merged in.

   Set the change to "Draft" if its still being worked on.

6. Wait for CI to pass and a CODEOWNER to review and merge.

Gitlab-CI

There is a lot of documentation available through Gitlab for building and maintaining .gitlab-ci.yml files.

Here are some useful references:

• .gitlab-ci.yml file syntax

• Gitlab's CI/CD examples, and templates

• Environment variables available to jobs

The Releng project also maintains some of templates for projects to use; Projects are under no obligation or requirement to use the templates provided by the Releng project.

• Docker

  ---
  include:
    - project: anuket/releng
      file: '/gitlab-templates/Docker.gitlab-ci.yml'

• ReadTheDocs (RTD)

  ---
  include:
    - project: anuket/releng
      file: '/gitlab-templates/RTD.gitlab-ci.yml'

• Google Storage (GSutil install)

  ---
  include:
    - project: anuket/releng
      file: '/gitlab-templates/GoogleStorage.gitlab-ci.yml'

Scheduled Jobs

Hosted Runners (External Hardware builds)