guibranco / github-badges-action

📄 :octocat: GitHub Action to update readme with badges
https://guibranco.github.io/github-badges-action/
MIT License
1 stars 0 forks source link

[FEATURE] Migrate and convert existing GitHub Action #28

Open guibranco opened 1 month ago

guibranco commented 1 month ago

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:

Notes:

gitauto-ai[bot] commented 1 month ago

Hello @guibranco, you have reached your request limit of 5, your cycle will refresh on 2024-09-21 10:07:38+00:00. Consider subscribing if you want more requests. If you have any questions or concerns, please contact us at info@gitauto.ai.

gitauto-ai[bot] commented 2 weeks ago

Hey, I'm a bit lost here! Not sure which file I should be fixing. Could you give me a bit more to go on? Maybe add some details to the issue or drop a comment with some extra hints? Thanks!

Have feedback or need help? Feel free to email info@gitauto.ai.