alibaba/GraphScope

Upgrade the build phase in CI with `gsctl`

Open

#2.925 geöffnet am 21. Juni 2023

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (1 zugewiesene Person)HTML (2.401 Stars) (301 Forks)batch import
component:dev-infracomponent:pythongood first issue

Beschreibung

Background: we are refactoring the existing command-line utility gs written in bash (with framework bashly), to Python-based gsctl (see #2825 and its PR) with package click. A bootstrap is built here, although some subcommands are still missing.

For this task, you may want to investigate all the build phase in the CI, replace them using gsctl build --xxx, to make the related sub-commands in gsctl robust and confident.

Here are some tips:

  • after checkout, the first command should be cd python/graphscope && pip install --editable . to make gsctl usable.
  • add the missing pieces, (options or subcommand) in gsctl, if any.
  • Please note there is a CI env in github actions. Check it if you have specific codings for CI runtime.
  • To make our life easier, you may leave build wheel related jobs untouched.

Contributor Guide

Tech Stack
pythongithub actions
Domain
ci cdbuild systemdeveloper experience
Issue Type
refactor
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
PythonCI/CD conceptsGitHub Actions
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60
Research-Richtung
Start by understanding the current CI build phase in the GitHub Actions workflow files (e.g., .github/workflows). Identify where the bash based `gs` is used and replace those commands with the equivalent `gsctl build xxx` commands. Refer to the existing bootstrap at python/graphscope/gsctl/gsctl.py and the related PR #2825 for guidance. Note that build wheel jobs should be left untouched. Additionally, check if any missing options or subcommands need to be added to gsctl to support the CI tasks, and be mindful of the CI environment variable.