GitHub security workshop: Add a custom CodeQL query exercise

Abierto
#274 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
64/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
github-actions, python
Área
ci-cd, documentation, security, testing-qa

Línea de trabajo

Comienza con el código Python de la pets app y con la ruta compatible de CodeQL CLI o hosted-workflow descrita en la incidencia. Define un ejemplo positivo y uno negativo deterministas, y documenta después la consulta inicial, el empaquetado, la configuración, los resultados esperados, la validación, las restricciones y el fallback, para que el ejercicio cumpla todos los criterios de aceptación.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

priority: deferred

Goal

Teach how CodeQL can enforce an organization-specific security rule that is not represented by the default query suite.

Scope

Choose one simple, app-relevant Python pattern and provide a small starter query that learners can understand and extend. Document the tested execution path using supported CodeQL tooling, then show how a query pack or configuration is incorporated into repository analysis.

Acceptance criteria

  • The target pattern is security-relevant, specific to the pets app, and has a deterministic positive and negative example.
  • The exercise explains the query metadata, imports, predicates, result selection, and help text at an introductory level.
  • A pinned/tested CodeQL CLI or supported hosted workflow is documented.
  • Learners run the query and see exactly the expected result set.
  • The custom query is packaged and referenced using a currently supported CodeQL configuration.
  • A subsequent repository analysis reports the custom result with recognizable metadata.
  • Maintainer validation detects query compilation failures and result drift.
  • The exercise documents feature or plan constraints and an observation-only fallback.
Lenguaje dominante
Python
Estrellas
80
Forks
161
Merge medio
31 min
PR fusionados (30 d)
1

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de github-samples/pets-workshop

Todos los issues de github-samples/pets-workshop

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.