Rake tasks for developers
Rake tasks are available for developers and others contributing to GitLab.
Set up database with developer seeds
Note that if your database user does not have advanced privileges, you must create the database manually before running this command.
bundle exec rake setup
setup task is an alias for
This tasks calls
db:reset to create the database, and calls
db:seed_fu to seed the database.
db:seed but this does nothing.
MASS_INSERT: Create millions of users (2m), projects (5m) and its relations. It's highly recommended to run the seed with it to catch slow queries while developing. Expect the process to take up to 20 extra minutes.
See also Mass inserting Rails models.
LARGE_PROJECTS: Create large projects (through import) from a predefined set of URLs.
Seeding issues for all or a given project
You can seed issues for all or a given project with the
# All projects bin/rake gitlab:seed:issues # A specific project bin/rake "gitlab:seed:issues[group-path/project-path]"
By default, this seeds an average of 2 issues per week for the last 5 weeks per project.
Seeding issues for Insights charts (ULTIMATE)
You can seed issues specifically for working with the
Insights charts with the
# All projects bin/rake gitlab:seed:insights:issues # A specific project bin/rake "gitlab:seed:insights:issues[group-path/project-path]"
By default, this seeds an average of 10 issues per week for the last 52 weeks per project. All issues are also randomly labeled with team, type, severity, and priority.
Seeding groups with subgroups
You can seed groups with subgroups that contain milestones/projects/issues
bin/rake "gitlab:seed:group_seed[subgroup_depth, username]"
Group are additionally seeded with epics if GitLab instance has epics feature available.
Seeding a runner fleet test environment
gitlab:seed:runner_fleet task to seed a full runner fleet, specifically groups with subgroups and projects that contain runners and pipelines:
bin/rake "gitlab:seed:runner_fleet[username, registration_prefix, runner_count, job_count]"
By default, the Rake task uses the
root username to create 40 runners and 400 jobs.
graph TD G1[Top level group 1] --> G11 G2[Top level group 2] --> G21 G11[Group 1.1] --> G111 G11[Group 1.1] --> G112 G111[Group 1.1.1] --> P1111 G112[Group 1.1.2] --> P1121 G21[Group 2.1] --> P211 P1111[Project 22.214.171.124<br><i>70% of jobs, sent to first 5 runners</i>] P1121[Project 126.96.36.199<br><i>15% of jobs, sent to first 5 runners</i>] P211[Project 2.1.1<br><i>15% of jobs, sent to first 5 runners</i>] IR1[Instance runner] P1111R1[Shared runner] P1111R[Project 188.8.131.52 runners<br>20% total runners] P1121R[Project 184.108.40.206 runners<br>49% total runners] G111R[Group 1.1.1 runners<br>30% total runners<br><i>remaining jobs</i>] G21R[Group 2.1 runners<br>1% total runners] P1111 --> P1111R1 P1111 --> G111R P1111 --> IR1 P1111 --> P1111R P1121 --> P1111R1 P1121 --> IR1 P1121 --> P1121R P211 --> P1111R1 P211 --> G21R P211 --> IR1 classDef groups fill:#09f6,color:#000000,stroke:#333,stroke-width:3px; classDef projects fill:#f96a,color:#000000,stroke:#333,stroke-width:2px; class G1,G2,G11,G111,G112,G21 groups class P1111,P1121,P211 projects
Seeding custom metrics for the monitoring dashboard
A lot of different types of metrics are supported in the monitoring dashboard.
To import these metrics, you can run:
bundle exec rake 'gitlab:seed:development_metrics[your_project_id]'
Seed a project with vulnerabilities
You can seed a project with security vulnerabilities.
# Seed all projects bin/rake 'gitlab:seed:vulnerabilities' # Seed a specific project bin/rake 'gitlab:seed:vulnerabilities[group-path/project-path]'
If you're very sure that you want to wipe the current database and refill
seeds, you can set the
FORCE environment variable to
FORCE=yes bundle exec rake setup
This will skip the action confirmation/safety check, saving you from answering
Since the script would print a lot of information, it could be slowing down
your terminal, and it would generate more than 20G logs if you just redirect
it to a file. If we don't care about the output, we could just redirect it to
echo 'yes' | bundle exec rake setup > /dev/null
Note that since you can't see the questions from
stdout, you might just want
echo 'yes' to keep it running. It would still print the errors on
so no worries about missing errors.
Extra Project seed options
There are a few environment flags you can pass to change how projects are seeded
SIZE: defaults to
32. Amount of projects to create.
LARGE_PROJECTS: defaults to false. If set, clones 6 large projects to help with testing.
FORK: defaults to false. If set to
torvalds/linuxfive times. Can also be set to an existing project
full_pathto fork that instead.
In order to run the test you can use the following commands:
bin/rake specto run the RSpec suite
bin/rake spec:unitto run only the unit tests
bin/rake spec:integrationto run only the integration tests
bin/rake spec:systemto run only the system tests
bin/rake spec takes significant time to pass.
Instead of running the full test suite locally, you can save a lot of time by running
a single test or directory related to your changes. After you submit a merge request,
CI runs full test suite for you. Green CI status in the merge request means
full test suite is passed.
You can't run
rspec . since this tries to run all the
files it can find, also the ones in
You can pass RSpec command line options to the
spec:system tasks. For example,
bin/rake "spec:unit[--tag ~geo --dry-run]".
For an RSpec test, to run a single test file you can run:
To run several tests inside one directory:
bin/rspec spec/requests/api/for the RSpec tests if you want to test API only
Run RSpec tests which failed in Merge Request pipeline on your machine
If your Merge Request pipeline failed with RSpec test failures, you can run all the failed tests on your machine with the following Rake task:
There are a few caveats for this Rake task:
- You need to be on the same branch on your machine as the source branch of the Merge Request.
- The pipeline must have been completed.
- You may need to wait for the test report to be parsed and retry again.
This Rake task depends on the unit test reports feature, which only gets parsed when it is requested for the first time.
Speed up tests, Rake tasks, and migrations
Spring is a Rails application pre-loader. It speeds up development by keeping your application running in the background so you don't need to boot it every time you run a test, Rake task or migration.
If you want to use it, you must export the
Alternatively you can use the following on each spec run,
bundle exec spring rspec some_spec.rb
Generate initial RuboCop TODO list
One way to generate the initial list is to run the Rake task
bundle exec rake rubocop:todo:generate
To generate TODO list for specific RuboCop rules, pass them comma-seperated as argument to the Rake task:
bundle exec rake 'rubocop:todo:generate[Gitlab/NamespacedClass,Lint/Syntax]' bundle exec rake rubocop:todo:generate\[Gitlab/NamespacedClass,Lint/Syntax\]
Some shells require brackets to be escaped or quoted.
See Resolving RuboCop exceptions on how to proceed from here.
Run RuboCop in graceful mode
You can run RuboCop in "graceful mode". This means all enabled cop rules are
silenced which have "grace period" activated (via
Details: grace period).
bundle exec rake 'rubocop:check:graceful' bundle exec rake 'rubocop:check:graceful[Gitlab/NamespacedClass]'
Compile Frontend Assets
You shouldn't ever need to compile frontend assets manually in development, but if you ever need to test how the assets get compiled in a production environment you can do so with the following command:
RAILS_ENV=production NODE_ENV=production bundle exec rake gitlab:assets:compile
with all other frontend assets (images, fonts, etc) into
they can be easily inspected.
To update the Emoji aliases file (used for Emoji autocomplete), run the following:
bundle exec rake tanuki_emoji:aliases
To update the Emoji digests file (used for Emoji autocomplete), run the following:
bundle exec rake tanuki_emoji:digests
This updates the file
fixtures/emojis/digests.json based on the currently
To generate a sprite file containing all the Emoji, run:
bundle exec rake tanuki_emoji:sprite
If new emoji are added, the sprite sheet may change size. To compensate for
such changes, first generate the
emoji.png sprite sheet with the above Rake
task, then check the dimensions of the new sprite sheet and update the
SPRITESHEET_HEIGHT constants accordingly.
Update project templates
Starting a project from a template needs this project to be exported. On a up to date main branch run:
gdk start bundle exec rake gitlab:update_project_templates git checkout -b update-project-templates git add vendor/project_templates git commit git push -u origin update-project-templates
Now create a merge request and merge that to main.
To update just a single template instead of all of them, specify the template name
between square brackets. For example, for the
cluster_management template, run:
bundle exec rake gitlab:update_project_templates\[cluster_management\]
Generate route lists
To see the full list of API routes, you can run:
bundle exec rake grape:path_helpers
The generated list includes a full list of API endpoints and functional RESTful API verbs.
For the Rails controllers, run:
bundle exec rails routes
Since these take some time to create, it's often helpful to save the output to a file for quick reference.
To see a list of all obsolete
bundle exec rake db:obsolete_ignored_columns
Feel free to remove their definitions from their
Validate GraphQL queries
To check the validity of one or more of our front-end GraphQL queries, run:
# Validate all queries bundle exec rake gitlab:graphql:validate # Validate one query bundle exec rake gitlab:graphql:validate[path/to/query.graphql] # Validate a directory bundle exec rake gitlab:graphql:validate[path/to/queries]
This prints out a report with an entry for each query, explaining why each query is invalid if it fails to pass validation.
We strip out
@client fields during validation so it is important to mark
client fields with the
@client directive to avoid false positives.
Analyze GraphQL queries
ANALYZE in SQL, we can run
estimate the of the cost of running a query.
# Analyze all queries bundle exec rake gitlab:graphql:analyze # Analyze one query bundle exec rake gitlab:graphql:analyze[path/to/query.graphql] # Analyze a directory bundle exec rake gitlab:graphql:analyze[path/to/queries]
This prints out a report for each query, including the complexity of the query if it is valid.
The complexity depends on the arguments in some cases, so the reported complexity is a best-effort assessment of the upper bound.
Update GraphQL documentation and schema definitions
To generate GraphQL documentation based on the GitLab schema, run:
bundle exec rake gitlab:graphql:compile_docs
In its current state, the Rake task:
- Generates output for GraphQL objects.
- Places the output at
This uses some features from
graphql-docs gem like its schema parser and helper methods.
The docs generator code comes from our side giving us more flexibility, like using Haml templates and generating Markdown files.
To edit the content, you may need to edit the following:
- The template. You can edit the template at
tooling/graphql/docs/templates/default.md.haml. The actual renderer is at
- The applicable
descriptionfield in the code, which Updates machine-readable schema files, which is then used by the
raketask described earlier.
@parsed_schema is an instance variable that the
graphql-docs gem expects to have available.
Gitlab::Graphql::Docs::Helper defines the
object method we currently use. This is also where you
should implement any new methods for new types you'd like to display.
Update machine-readable schema files
To generate GraphQL schema files based on the GitLab schema, run:
bundle exec rake gitlab:graphql:schema:dump
This uses GraphQL Ruby's built-in Rake tasks to generate files in both IDL and JSON formats.
Update documentation and schema definitions
The following command combines the intent of Update GraphQL documentation and schema definitions and Update machine-readable schema files:
bundle exec rake gitlab:graphql:update_all
Update OpenAPI client for Error Tracking feature
This Rake task needs
docker to be installed.
To update generated code for OpenAPI client located in
vendor/gems/error_tracking_open_api run the following commands:
# Run rake task bundle exec rake gems:error_tracking_open_api:generate # Review and test the changes # Commit the changes git commit -m 'Update ErrorTrackingOpenAPI from OpenAPI definition' vendor/gems/error_tracking_open_api
Update banned SSH keys
You can add banned SSH keys
from any Git repository by using the
gitlab:security:update_banned_ssh_keys Rake task:
Find a public remote Git repository containing SSH public keys. The public key files must have the
Make sure that
/tmp/directory has enough space to store the remote Git repository.
To add the SSH keys to your banned-key list, run this command, replacing
OUTPUT_FILEwith appropriate values:
# @param git_url - Remote Git URL. # @param output_file - Update keys to an output file. Default is config/security/banned_ssh_keys.yml. bundle exec rake "gitlab:security:update_banned_ssh_keys[GIT_URL, OUTPUT_FILE]"
This task clones the remote repository, recursively walks the file system looking for files
.pub, parses those files as SSH public keys, and then adds the public key fingerprints
output_file. The contents of
config/security/banned_ssh_keys.yml is read by GitLab and kept
in memory. It is not recommended to increase the size of this file beyond 1 megabyte in size.