Roles requeridos
Para obtener los permisos que necesitas para trabajar con plantillas de problemas y solicitud de extracción, pídele a tu administrador que te otorgue los siguientes roles de IAM:
-
Secure Source Manager Instance Accessor (
roles/securesourcemanager.instanceAccessor) en la instancia de Secure Source Manager -
Escritor de repositorios de Secure Source Manager (
roles/securesourcemanager.repoWriter) en el repositorio
Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.
También puedes obtener los permisos necesarios a través de roles personalizados o cualquier otro rol predefinido.
Para obtener información sobre cómo otorgar roles de Secure Source Manager, consulta Control de acceso con IAM y Cómo otorgar acceso a la instancia a los usuarios.
Descripción general de las plantillas
Las plantillas de problemas y solicitud de extracción te permiten estandarizar la información que los colaboradores proporcionan a un repositorio. Las plantillas de problemas ofrecen opciones predefinidas que un usuario puede elegir según el tipo de problema que envía y los tipos de plantillas disponibles. Una plantilla de solicitud de extracción se aplica automáticamente a todas las solicitudes de extracción, lo que garantiza contribuciones coherentes al repositorio.
Cualquier persona con permiso para combinar archivos en un repositorio puede crear plantillas.
Crea una plantilla de problemas
Secure Source Manager te permite definir plantillas de problemas con archivos Markdown en varias ubicaciones de tu repositorio. Puedes crear varias plantillas de problemas para diferentes propósitos. Por ejemplo, es posible que desees tener plantillas separadas para informar errores y enviar solicitudes de funciones.
Crea una plantilla que comience con la siguiente información, en este formato exacto:
--- name: TEMPLATE_NAME about: Insert description of template title: Placeholder title for the new issue when it is created ---Proporciona un nombre y una descripción. Estos campos son obligatorios y se utilizan en la IU de la página New Issues.
De manera opcional, puedes incluir un título que se use como título de marcador de posición cuando se cree un problema nuevo.
Debajo del material obligatorio, incluye la información que quieras que se vea en la descripción del problema y que ayude a los usuarios a proporcionar la información necesaria.
Guarda la plantilla como un archivo de Markdown en una de las siguientes ubicaciones:
/.securesourcemanager/ISSUE_TEMPLATES//.securesourcemanager/issue_templates/
Plantilla de problemas predeterminada
Secure Source Manager también admite la definición de una sola plantilla predeterminada. Esta plantilla debe definirse en una de las siguientes ubicaciones:
/.securesourcemanager/ISSUE_TEMPLATE.md/.securesourcemanager/issue_template.md
Cuando un usuario crea un problema nuevo, Secure Source Manager le solicita que seleccione una plantilla, si hay alguna disponible, o selecciona la plantilla predeterminada. Si no hay una plantilla predeterminada designada, no se completará previamente nada en el problema nuevo.
Plantilla de ejemplo de problemas
Las primeras 5 líneas de la plantilla deben seguir las convenciones que se describen en el siguiente ejemplo. Cualquier información adicional se puede formatear en Markdown para adaptarse a las necesidades del tipo de problema.
---
name: Bug #Used as UI element for the button on the New Issues page
about: Use this template to submit a new bug #Used as description text on the New Issues page
title: [BUG]: <Describe issue> #Used as placeholder name for newly created issue
---
# Description
# Expected result
# Actual result
# Steps to reproduce
1.
2.
# Environment
-OS:
-Software version:
-Screenshots:
Crea una plantilla de solicitud de extracción
Crea una plantilla que comience con la siguiente información, en este formato exacto:
--- title: "[PR]: <Insert title>" ---Debajo del material obligatorio, incluye la información que quieras que se vea en la descripción del problema para ayudar a los usuarios a proporcionar la información necesaria. Consulta la plantilla de ejemplo en la siguiente sección para obtener más detalles.
Guarda la plantilla como un archivo Markdown en una de las siguientes ubicaciones dentro de un repositorio:
/.securesourcemanager/PULL_REQUEST_TEMPLATE.md/.securesourcemanager/pull_request_template.md
Cuando creas una solicitud de extracción nueva, Secure Source Manager verifica si existe una plantilla en alguna de las ubicaciones definidas y la carga. Si incluiste información de título en tu plantilla, se completará automáticamente en la nueva solicitud de extracción para proporcionar a los usuarios un formato definido que deben seguir. Toda la información adicional que hayas incluido se agregará a la descripción de la solicitud de extracción para que la actualice el usuario que la envió.
Ejemplo de plantilla de solicitud de extracción
Las primeras 3 líneas de la plantilla deben seguir las convenciones que se muestran en el siguiente ejemplo. Todo lo que sigue son opciones y deberían ayudar a los usuarios a crear solicitudes de extracción que sigan tus convenciones.
---
title: "[PR]: <Insert title>"
---
<!-- Thank you for your contribution! -->
<!-- Include if applicable: -->
Fixes: #nnn <!-- tracking issues that this PR will close -->
**Related**: _Relevant tracking issues, for context_
**Merge before/after**: _Dependent or prerequisite PRs_
**Description**
<!-- Describe your changes here. The more detail, the easier the review! -->
**User facing changes (remove if N/A)**
<!-- Describe any user facing changes this PR introduces. -->
<!-- "Before" and "After" sections work great - bonus points for screenshots! -->
<!-- Be sure all docs have been updated as well! -->
**Follow-up Work (remove if N/A)**
<!-- Mention any related follow up work to this PR. -->
¿Qué sigue?
- Visita Trabaja con problemas y solicitudes de extracción para obtener detalles sobre cómo trabajar con problemas y solicitudes de extracción en Secure Source Manager.