lib/gitlab/client/lint.rb - ruby-gitlab (56aea8b)

Tree @56aea8b (Download .tar.gz)

..
access_requests.rb
application_settings.rb
avatar.rb
award_emojis.rb
boards.rb
branches.rb
broadcast_messages.rb
build_variables.rb
builds.rb
commits.rb
container_registry.rb
deployments.rb
environments.rb
epics.rb
events.rb
features.rb
group_boards.rb
group_labels.rb
group_milestones.rb
groups.rb
issue_links.rb
issues.rb
jobs.rb
keys.rb
labels.rb
lint.rb
markdown.rb
merge_request_approvals.rb
merge_requests.rb
milestones.rb
namespaces.rb
notes.rb
pipeline_schedules.rb
pipeline_triggers.rb
pipelines.rb
project_badges.rb
project_clusters.rb
project_release_links.rb
project_releases.rb
projects.rb
protected_tags.rb
repositories.rb
repository_files.rb
repository_submodules.rb
resource_label_events.rb
runners.rb
search.rb
services.rb
sidekiq.rb
snippets.rb
system_hooks.rb
tags.rb
templates.rb
todos.rb
users.rb
versions.rb
wikis.rb

lint.rb @56aea8b — raw · history · blame

# frozen_string_literal: true

class Gitlab::Client
  # Defines methods related to lint/validations.
  # @see https://docs.gitlab.com/ce/api/lint.html
  module Lint
    # Checks if your .gitlab-ci.yml file is valid.
    #
    # @example
    #   Gitlab.validate_gitlab_ci_yml("{ \"image\": \"ruby:2.6\", \"services\": [\"postgres\"], \"before_script\": [\"bundle install\", \"bundle exec rake db:create\"], \"variables\": {\"DB_NAME\": \"postgres\"}, \"types\": [\"test\", \"deploy\", \"notify\"], \"rspec\": { \"script\": \"rake spec\", \"tags\": [\"ruby\", \"postgres\"], \"only\": [\"branches\"]}}")
    #
    # @param  [String] content the .gitlab-ci.yaml content.
    # @return <Gitlab::ObjectifiedHash> Returns information about validity of the yml.
    def validate_gitlab_ci_yml(content)
      body = { content: content }
      post('/lint', body: body)
    end
  end
end