Describe publish:github scaffolder action fields

Currently the fields of the publish:github action uses some undocumented
conventions in the repoUrl and access input fields.

This change adds a description to the fields with examples of what to input. The
collaborators description is also expanded a bit to make it more clear that
these are additional compared to access and owner.

Signed-off-by: Crevil <bjoern.soerensen@gmail.com>
This commit is contained in:
Crevil
2021-06-15 12:13:09 +02:00
parent f681f408d4
commit 7453511900
2 changed files with 12 additions and 1 deletions
@@ -59,6 +59,7 @@ export function createPublishGithubAction(options: {
properties: {
repoUrl: {
title: 'Repository Location',
description: `Accepts the format 'github.com?repo=reponame&owner=owner' where 'reponame' is the new repository name and 'owner' is an organization or username`,
type: 'string',
},
description: {
@@ -67,6 +68,7 @@ export function createPublishGithubAction(options: {
},
access: {
title: 'Repository Access',
description: `Sets an admin collaborator on the repository. Can either be a user reference different from 'owner' in 'repoUrl' or team reference, eg. 'org/team-name'`,
type: 'string',
},
repoVisibility: {
@@ -81,7 +83,7 @@ export function createPublishGithubAction(options: {
},
collaborators: {
title: 'Collaborators',
description: 'Provide users with permissions',
description: 'Provide additional users with permissions',
type: 'array',
items: {
type: 'object',