Skip to content

Secret personal snippets

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

I would like to have snippets that are viewable by everyone, but not listed everywhere (IE you have to know the URL). Just like secret gists on GitHub Gist.

An additional requirement has added a secret parameter to the URL for access. This parameter could also be rotated if you wanted to rotate access.

We’ll probably need UX decisions regarding how this new setting will look like on snippet creation (check/radio) and how the secret snippet will present the link for sharing (there were some comments about the way GDocs handles sharing). Search results need to filter out secret snippets as well.

Test plan

Search results and listing pages should hide secret snippet

  • Test search with Elasticsearch.
  • Test search without Elasticsearch.
  • Test explore page
  • Test API
  • Test snippet dashboards (e.g. All, Internal, Public counts / visibility)
  • Test SnippetFinder
  • Test snippet creation (secret generation etc.)
  • Test snippet URL should be publicly accessible

Public snippets shouldn't be converted to private

Possible Merge Request breakdown

  • MR adding new setting field to snippet form
  • MR updating SnippetsFinder to not include secret snippets in lists
  • MR with any changes to the Search Service (to not index secret snippets or to skip them in search results)
Edited by 🤖 GitLab Bot 🤖