guibranco / guibranco/github-badges-action

[FEATURE] Migrate and convert existing GitHub Action

Open
#28 2 comments 1 reaction 0 assignees View on GitHub
:octocat: github-actions ⚙️ CI/CD 👷🏼 infrastructure 📝 documentation 🕔 high effort enhancement gitauto javascript TypeScript 🧠 backlog
Dominant language
TypeScript
Stars
4
Forks
0
Avg merge
55m
Merged PRs (30d)
29

Description

#### 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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.