Skip to content

GitLab Next

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
GitLab
GitLab
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 34,980
    • Issues 34,980
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
    • Iterations
  • Merge Requests 1,267
    • Merge Requests 1,267
  • Requirements
    • Requirements
    • List
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
    • Test Cases
  • Security & Compliance
    • Security & Compliance
    • Dependency List
    • License Compliance
  • Operations
    • Operations
    • Metrics
    • Incidents
    • Environments
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Analytics
    • Analytics
    • CI / CD
    • Code Review
    • Insights
    • Issue
    • Repository
    • Value Stream
  • Snippets
    • Snippets
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
  • GitLab.org
  • GitLabGitLab
  • Merge Requests
  • !16438

Merged
Opened Sep 11, 2019 by charlie ablett@cablett🔶Maintainer5 of 5 tasks completed5/5 tasks

Add cop to check for GraphQL field descriptions (EE)

  • Overview 15
  • Commits 3
  • Pipelines 7
  • Changes 40

What does this MR do?

EE port of https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/32725

Adds a Rubocop custom cop to raise an error if a modified GraphQL field is missing a description. Since descriptions are a part of the generated GraphQL docs, having the descriptions filled in makes it more useful.

This cop ignores existing failures, but #67087 addresses that.

Does this MR meet the acceptance criteria?

Conformity

  • [-] Changelog entry for user-facing changes, or community contribution. Check the link for other scenarios.
  • [-] Documentation created/updated or follow-up review issue created
  • Code review guidelines
  • [-] Merge request performance guidelines
  • Style guides
  • [-] Database guides
  • Separation of EE specific content

Performance and Testing

  • Review and add/update tests for this feature/bug. Consider all test levels. See the Test Planning Process.
  • Tested in all supported browsers

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • [-] Label as security and @ mention @gitlab-com/gl-security/appsec
  • [-] The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
  • [-] Security reports checked/validated by a reviewer from the AppSec team
Edited Sep 13, 2019 by charlie ablett
Assignee
Assign to
Reviewer
Request review from
12.3
Milestone
12.3 (Past due)
Assign milestone
Time tracking
Reference: gitlab-org/gitlab!16438
Source branch: cop-for-graphql-field-descriptions-ee

Revert this merge request

This will create a new commit in order to revert the existing changes.

Switch branch
Cancel
A new branch will be created in your fork and a new merge request will be started.

Cherry-pick this merge request

Switch branch
Cancel
A new branch will be created in your fork and a new merge request will be started.