Push a commit to and open a pull request on pyvideo/pyvideo when new data is merged into main

Abierto
  • ¿Algo no está bien?
#1,184 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
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
git, github, github-actions
Área
ci-cd, devops

Línea de trabajo

Start with the merge-to-main trigger and the linked action-pull-request and action-commit-push examples. Verify the cross-repository branch, submodule update, push, and pull request flow, including a custom GitHub secret; done means data changes create or update the expected pull request while documentation-only changes are skipped.

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

Descripción

The current process for updating data in the https://github.com/pyvideo/pyvideo repository (which is where the site is built and deployed from) is a manual update of the git submodule. This almost always follows the same automatable process of create a "fastforward-data-dir" branch -> update the data submodule -> open a pull request on pyvideo/pyvideo to preview changes. While this is not a large task, it's consistent enough that it's worth automating via GitHub Actions. A suitable workflow would look like the following steps triggered by a merge to main (skipping commits where the affected filepaths do not modify any of the site data, e.g. documentation-only changes):

  1. Create a "fastforward-data-directory" branch for pyvideo/pyvideo if one does not already exist, or fetch the existing branch if it does
  2. Update the data submodule to point to the new latest commit (i.e. the merge that triggers the workflow)
  3. Push the branch to the pyvideo/pyvideo repository
  4. Open a pull request if one does not already exist

There are several approaches that can be used for this task, including GitHub actions using the GitHub CLI or off the shelf actions like action-pull-request and action-commit-push. One GitHub limitation to note: a custom GitHub token must be used in order for a commit pushed by an action to trigger another action, so the implementation should support pulling that value from a GitHub secret (there are examples of this in the linked push and pull request actions).

Lenguaje dominante
Python
Estrellas
484
Forks
288
Sin PR fusionados en 30 d

Preparar el entorno

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 pyvideo/data

Todos los issues de pyvideo/data

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.