Backend: Add optional description field for Project and Group CI variables
Summary
It can be easy to forget the value and source of specific variables added to Project or Group CI variables. Occasionally we will look at our docs and see a key like GITLAB_TOKEN
which relies on individual's memory to track rotations and the fields importance.
Proposal
We would like to include an optional description field that can be filled with arbitrary value to better describe what a variable is being used for.
Additional details
Some relevant technical details, if applicable, such as:
- Does this need a feature flag?
- Does there need to be an associated instrumentation issue created related to this work?
- Is there an example response showing the data structure that should be returned (new endpoints only)?
- What permissions should be used?
- Is this EE or CE?
-
EE -
CE
-
- Additional comments:
Additional details, to summarise:
- I suppose it could be implemented for CE, nothing special is required in EE.
- Could we define a length limitation for the description 150-200 characters may be suitable for most cases.
- Permissions should be aligned with the same user who is allowed for variable creations/updates.
- Endpoints - considering that we have for add/update functionality GraphQL mutation, it would require a minimum of changes from the endpoints side
- Extending any potentially already existing endpoints other than GraphQL endpoints necessary to fulfill frontend needs, could be implemented if necessary as a follow-up issue.
- MR would require database review and labeled with
database
label.
Implementation Table
-
Create new columns description
( optional ) with validation and size limit
Group | Issue Link |
---|---|
backend |
|
frontend | Frontend: Add optional description field for Pr... (#378938 - closed) |
Links/References
Edited by Max Orefice