Skip to main content

Administración de conjuntos de reglas de un repositorio

Puede editar, supervisar y eliminar conjuntos de reglas existentes en un repositorio para modificar cómo las personas pueden interactuar con ramas y etiquetas específicas.

¿Quién puede utilizar esta característica?

Cualquier persona con acceso de lectura a un repositorio puede ver los conjuntos de reglas del repositorio. Las personas con acceso de administrador a un repositorio o un rol personalizado con el permiso "editar reglas de repositorio", pueden crear, editar y eliminar conjuntos de reglas para un repositorio.

Los conjuntos de reglas están disponibles en los repositorios públicos con GitHub Free y GitHub Free para organizaciones, y en los repositorios públicos y privados con GitHub Pro, GitHub Team y GitHub Enterprise Cloud. Para más información, consulta planes de GitHub.

Los conjuntos de reglas de inserción están disponibles para el plan GitHub Team en repositorios internos y privados, y bifurcaciones de repositorios que tienen habilitados conjuntos de reglas de inserción.

Después de crear un conjunto de reglas, puedes realizar cambios en él. Por ejemplo, puede agregar reglas para proteger mejor las ramas o etiquetas, o bien deshabilitar temporalmente un conjunto de reglas para solucionar los efectos no deseados en la experiencia de colaborador del repositorio.

Puede usar las API de REST y GraphQL para gestionar rulesets. Para más información, consulta Puntos de conexión de la API de REST para reglas y Mutaciones.

Visualización de conjuntos de reglas de un repositorio

En la página "Conjuntos de reglas", cualquier persona con acceso de lectura al repositorio puede ver los conjuntos de reglas activos destinados a una determinada rama, etiqueta o restricción de inserción de.

En el caso de los conjuntos de reglas de envío para repositorios bifurcados, la página «Conjuntos de reglas» indicará que el conjunto de reglas es gestionado por el repositorio de origen donde se aplican las reglas.

  1. En GitHub, navegue hasta la página principal del repositorio.

  2. En la vista de árbol de archivos de la izquierda, selecciona el menú desplegable de ramas de y, a continuación, haz clic en View all branches. También puedes encontrar el menú desplegable de ramas en la parte superior del editor de archivos integrado.

    Captura de pantalla de la vista de árbol de archivos de un repositorio. Un menú desplegable para cambiar de rama se expande y se destaca en naranja oscuro.

  3. A la izquierda de la rama, haz clic en .

    Sugerencia

    Solo las ramas que tienen un conjunto de reglas tienen un icono adyacente a su nombre.

  4. Opcionalmente, para filtrar los resultados, haga clic en las pestañas o use la barra de búsqueda «Buscar sucursales».

  5. Haz clic en el nombre del conjunto de reglas que quieres ver.

También puede ver los conjuntos de reglas activos:

  • Al agregar el slug /rules a la dirección URL del repositorio. Por ejemplo, para ver las reglas del repositorio de documentación de open source en GitHub, vaya a https://github.com/github/docs/rules.

  • En el cuadro de combinación, si existen reglas que bloquean la combinación de una solicitud de incorporación de cambios.

Edición de un conjunto de reglas

Puedes editar un conjunto de reglas para cambiar partes del conjunto de reglas, como el nombre, permisos de omisión o reglas. También puedes editar un conjunto de reglas para cambiar su estado; por ejemplo, si deseas habilitar o deshabilitar temporalmente un conjunto de reglas.

  1. En GitHub, navegue hasta la página principal del repositorio.

  2. Debajo del nombre del repositorio, haz clic en Settings. Si no puedes ver la pestaña "Configuración", selecciona el menú desplegable y, a continuación, haz clic en Configuración.

    Captura de pantalla de un encabezado de repositorio en el que se muestran las pestañas. La pestaña "Configuración" está resaltada con un contorno naranja oscuro.

  3. En la barra lateral izquierda, en "Código y automatización", haz clic en Reglas y, a continuación, haz clic en Conjuntos de reglas.

    Captura de pantalla de la barra lateral de la página "Configuración" de un repositorio. El submenú "Reglas" se expande y la opción "Conjuntos de reglas" tiene un contorno naranja.

  4. En la página "Conjuntos de reglas", haz clic en el nombre del conjunto de reglas que deseas editar.

  5. Cambie el conjunto de reglas según sea necesario. Para obtener información sobre las reglas disponibles, consulta Reglas disponibles para conjuntos de reglas.

  6. En la parte inferior de la página, haga clic en Save changes.

Eliminación de un conjunto de reglas

Sugerencia

Si deseas deshabilitar temporalmente un conjunto de reglas, pero no deseas eliminarlo, puedes establecer el estado del conjunto de reglas en "Disabled". Para más información, consulta Edición de un conjunto de reglas.

  1. En GitHub, navegue hasta la página principal del repositorio.

  2. Debajo del nombre del repositorio, haz clic en Settings. Si no puedes ver la pestaña "Configuración", selecciona el menú desplegable y, a continuación, haz clic en Configuración.

    Captura de pantalla de un encabezado de repositorio en el que se muestran las pestañas. La pestaña "Configuración" está resaltada con un contorno naranja oscuro.

  3. En la barra lateral izquierda, en "Código y automatización", haz clic en Reglas y, a continuación, haz clic en Conjuntos de reglas.

    Captura de pantalla de la barra lateral de la página "Configuración" de un repositorio. El submenú "Reglas" se expande y la opción "Conjuntos de reglas" tiene un contorno naranja.

  4. Haz clic en el nombre del conjunto de reglas que quieres eliminar.

  5. A la derecha del nombre del conjunto de reglas, selecciona y, a continuación, haz clic en Delete ruleset.

    Captura de pantalla de la página para editar un conjunto de reglas. Debajo de un botón etiquetado con tres puntos, una opción con la etiqueta "Eliminar conjunto de reglas" se resalta en naranja.

Importación de un conjunto de reglas

Puedes importar un conjunto de reglas existente mediante un archivo JSON. Esto puede ser útil si deseas aplicar el mismo conjunto de reglas a varios repositorios u organizaciones.

  1. En GitHub, navegue hasta la página principal del repositorio.

  2. Debajo del nombre del repositorio, haz clic en Settings. Si no puedes ver la pestaña "Configuración", selecciona el menú desplegable y, a continuación, haz clic en Configuración.

    Captura de pantalla de un encabezado de repositorio en el que se muestran las pestañas. La pestaña "Configuración" está resaltada con un contorno naranja oscuro.

  3. En la barra lateral izquierda, en "Código y automatización", haz clic en Reglas y, a continuación, haz clic en Conjuntos de reglas.

    Captura de pantalla de la barra lateral de la página "Configuración" de un repositorio. El submenú "Reglas" se expande y la opción "Conjuntos de reglas" tiene un contorno naranja.

  4. Selecciona la lista desplegable Nuevo conjunto de reglas y haz clic en Importar un conjunto de reglas.

    Captura de pantalla de la página de conjuntos de reglas del repositorio. El menú desplegable "Nuevo conjunto de reglas" se expande y la opción "Importar un conjunto de reglas" está resaltada en naranja.

  5. Abre el archivo JSON exportado.

  6. Revisa el conjunto de reglas importado y haz clic en Crear.

Visualización de información para conjuntos de reglas

Puede ver información sobre los conjuntos de reglas para ver cómo afectan los conjuntos de reglas a un repositorio. En la página "Información sobre la regla", verás una escala de tiempo de las siguientes acciones de usuario. Puedes usar filtros para encontrar lo que buscas.

  • Acciones que se han comprobado con uno o varios conjuntos de reglas y que se han aprobado.
  • Acciones que se han comprobado con uno o varios conjuntos de reglas y que han generado un error.
  • Acciones en las que alguien ha omitido uno o varios conjuntos de reglas.

Si un conjunto de reglas se ejecuta en modo "Evaluar", puedes ver las acciones que se habrían aprobado o generado un error si el conjunto de reglas hubiera estado activo.

Además, estas conclusiones están disponibles a través de la API REST de conjuntos de reglas.

Captura de pantalla "Información sobre la regla". Se muestran tres acciones marcadas: "Pasar", "Omitir" y "Error". La acción con error tiene una etiqueta "evaluate".

  1. En GitHub, navegue hasta la página principal del repositorio.

  2. Debajo del nombre del repositorio, haz clic en Settings. Si no puedes ver la pestaña "Configuración", selecciona el menú desplegable y, a continuación, haz clic en Configuración.

    Captura de pantalla de un encabezado de repositorio en el que se muestran las pestañas. La pestaña "Configuración" está resaltada con un contorno naranja oscuro.

  3. En la barra lateral izquierda, en "Código y automatización", haga clic en Reglas y, a continuación, en Información.

    Captura de pantalla de la barra lateral de la página "Configuración" de un repositorio. El submenú "Reglas" se expande y la opción "Información" tiene un contorno naranja.

  4. En la página "Información sobre la regla", use los menús desplegables de la parte superior de la página para filtrar las acciones por conjunto de reglas, rama, actor y período de tiempo.

  5. Para ver qué reglas específicas han producido un error o requieren una omisión, haz clic en y expande el nombre del conjunto de reglas.

    Captura de pantalla "Información sobre la regla". A la derecha de un evento con la etiqueta "not-allowed", un icono de tres puntos horizontal está resaltado en naranja.