[FEATURE] Migrate and convert existing GitHub Action

Aperta
#28 2 commenti 1 reazione 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
github-actions, typescript

Direzione di ricerca

Inizia identificando l’Action attuale nel repository personale e i workflow esistenti, quindi esamina la tsconfig.json pianificata, la configurazione di tsc e i requisiti delle dipendenze. Verifica se esistono già test unitari prima di definire il lavoro di validazione. Il lavoro sarà considerato completato quando l’Action sarà migrata in un repository pubblico, convertita in TypeScript, testata nei workflow e documentata.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

:octocat: github-actions ⚙️ CI/CD 👷🏼 infrastructure 📝 documentation 🕔 high effort enhancement gitauto javascript TypeScript 🧠 backlog
Description

We must migrate an existing GitHub Action from a personal repository to a public and dedicated one. The current action is written in JavaScript, but as part of this migration, it should be refactored and rewritten in TypeScript for better type safety, maintainability, and scalability.

Task Overview:
  1. Repository Setup:

    • Create a new public repository dedicated to hosting the GitHub Action.
    • Configure repository settings (description, README, etc.).
  2. Migration of Action Code:

    • Migrate the current GitHub Action from the personal repository.
    • Ensure that the core functionality of the Action remains intact during migration.
  3. JavaScript to TypeScript Conversion:

    • Refactor the existing JavaScript code into TypeScript.
    • Add appropriate type definitions, interfaces, and enums to ensure the code meets TypeScript standards.
    • Set up TypeScript configuration (tsconfig.json) for the project.
  4. Testing and Validation:

    • Test the new TypeScript version of the Action locally.
    • Write unit tests (if not already present) to validate the Action’s functionality.
    • Ensure compatibility with GitHub Action workflows.
  5. Documentation Update:

    • Update or create documentation that reflects the new TypeScript implementation.
    • Provide instructions for how to use the Action in different workflows.
Acceptance Criteria:
  • The GitHub Action has been successfully migrated to a new public repository.
  • The Action is fully refactored from JavaScript to TypeScript.
  • All functionality is tested and working as expected.
  • Documentation is updated to reflect the new TypeScript version.
Notes:
  • Ensure that any dependencies and scripts required for TypeScript (e.g., @types, tsc command) are properly integrated into the repository.
  • Consider adding a CI/CD pipeline to automatically lint, build, and test the TypeScript code when changes are pushed to the repository.
Lingua principale
TypeScript
Stelle
4
Fork
0
Merge medio
25m
PR unite (30g)
23

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di guibranco/github-badges-action

Tutte le issue di guibranco/github-badges-action

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.