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 y ver la información del conjunto de reglas. Para más información, consulta "Acerca de los roles de repositorio personalizados".

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 Enterprise Cloud en repositorios internos y privados, bifurcaciones de repositorios que tienen conjuntos de reglas de inserción habilitados y organizaciones de tu empresa.

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 cambiar el conjunto de reglas del modo "Evaluar" a "Activo" después de probar sus efectos en la experiencia de colaborador del repositorio.

Puede usar la API de REST y Graph API para administrar conjuntos de reglas. Para obtener más información, vea «Puntos de conexión de la API de REST para reglas» y «Mutaciones».

Tip

Si eres el propietario de una organización, puedes crear conjuntos de reglas a nivel de organización. Puede aplicar estos conjuntos de reglas a repositorios específicos de su organización y a ramas específicas de esos repositorios. Para obtener más información, vea «Creación de conjuntos de reglas para repositorios de la organización».

Visualización de conjuntos de reglas de un repositorio

En la página "Rulesets", 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 envío de cambios. También verás los conjuntos de reglas que se ejecutan en modo "Evaluar", que no se aplican.

En el caso de los conjuntos de reglas de inserción para repositorios bifurcados, la página «Conjuntos de reglas» indicará que el conjunto de reglas se administra mediante el repositorio de origen donde se aplica la regla.

  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 Ver todas las ramas. 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 .

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

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

Edición de un conjunto de reglas

Note

Si se creó un conjunto de reglas a nivel de organización, no puedes editar el conjunto de reglas en la configuración del repositorio. Si tiene permiso para editar el conjunto de reglas, puede hacerlo en la configuración de la organización. Para obtener más información, vea «Administración de conjuntos de reglas para repositorios de la organización».

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. En el nombre del repositorio, haz clic en Configuración. 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

Tip

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

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

  2. En el nombre del repositorio, haz clic en Configuración. 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 Eliminar conjunto de reglas.

    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.

Uso del historial del conjunto de reglas

Note

  • El historial del conjunto de reglas está actualmente en versión preliminar pública y está sujeta a cambios.
  • Solo se incluyen en el historial del conjunto de reglas los cambios realizados en un conjunto de reglas después de la versión versión preliminar pública, el 11 de octubre de 2023.

Puedes ver todos los cambios en un conjunto de reglas y volver a una iteración específica. También puedes descargar un archivo JSON que contenga la configuración del conjunto de reglas en una iteración específica. La lista de omisión de un conjunto de reglas se excluye del archivo JSON exportado.

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

  2. En el nombre del repositorio, haz clic en Configuración. 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. Para ver el historial de cambios del conjunto de reglas, a la derecha del nombre del conjunto de reglas, selecciona y, a continuación, haz clic en Historial.

    Captura de pantalla de la página de conjuntos de reglas del repositorio. Debajo de un botón etiquetado con tres puntos, una opción con la etiqueta «Historial» está resaltada en naranja.

  5. A la derecha de la iteración específica, selecciona y, a continuación, haz clic en Comparar cambios, Restaurar o Descargar.

    Captura de pantalla de la página del historial de los conjuntos de reglas del repositorio. Un menú desplegable etiquetado con tres puntos se amplía y se destaca con un contorno naranja.

Importación de un conjunto de reglas

Puedes importar un conjunto de reglas desde otro repositorio u organización 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. En el nombre del repositorio, haz clic en Configuración. 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. Se expande un menú desplegable con la etiqueta «Nuevo conjunto de reglas» y la opción «Importar un conjunto de reglas» está resaltada con un contorno 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.

Captura de pantalla "Información sobre la regla". Se muestran tres acciones: una marcada como "aprobada", una marcada como "omitida" y otra marcada como "error" con una etiqueta "evaluar".

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

  2. En el nombre del repositorio, haz clic en Configuración. 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 "octocat created not-allowed", aparece un icono de tres puntos horizontal con un contorno naranja.

  6. Opcionalmente, revise los detalles de la cola de combinación para las solicitudes de cambios correspondientes del mismo grupo de combinación.

Administración de solicitudes para omitir las reglas de inserción

Note

La omisión delegada para las reglas de inserción se encuentra actualmente en versión preliminar pública y está sujeta a cambios.

Puede ver y administrar todas las solicitudes de privilegios de omisión en la página “Solicitudes de omisión”, ubicada en la pestaña Configuración de reglas del repositorio.

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

  2. En el nombre del repositorio, haz clic en Configuración. 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. Haga clic en Solicitudes de omisión.

Puede filtrar las solicitudes por aprobador (miembro de la lista de omisión), solicitante (colaborador que realiza la solicitud), período de tiempo y estado. Se asignan los siguientes estados a una solicitud:

EstadoDescripción
CancelledEl colaborador ha cancelado la solicitud.
CompletedLa solicitud se ha aprobado y las confirmaciones se han insertado en el repositorio.
DeniedSe ha revisado y denegado la solicitud.
ExpiredLa solicitud ha expirado. Las solicitudes son válidas durante 7 días.
OpenLa solicitud aún no se ha revisado o se ha aprobado, pero las confirmaciones no se han insertado en el repositorio.

Cuando un colaborador solicita privilegios de omisión para insertar una confirmación con contenido restringido, todos los miembros de la lista de omisión reciben una notificación por correo electrónico que contiene un vínculo a la solicitud. Los miembros de la lista de omisión tienen 7 días para revisar y aprobar o denegar la solicitud antes de que esta expire.

El colaborador recibe una notificación de la decisión por correo electrónico y debe realizar la acción necesaria. Si se aprueba la solicitud, el colaborador puede insertar la confirmación que con contenido restringido en el repositorio. Si se deniega la solicitud, el colaborador debe eliminar el contenido restringido de la confirmación para insertar correctamente la confirmación en el repositorio.