threeal / composite-action-starter

A minimalistic GitHub repository template to kickstart your GitHub composite action project

Alfi Maulana

A C++ enthusiast who is experienced with building and optimizing native apps on Linux, macOS, and Windows. Also, a fast learner and generalist who can develop multiple things like computer vision programs using OpenCV, shell scripts for CI workflows, web apps using TypeScript, and microservices using Go.

My Works

Aside from my current job, I also work on several personal projects. Currently, most of these projects are GitHub repository templates and GitHub Actions for utilizing my other projects. Please refer to my repositories for a list of all projects that I have done.

C++ Projects

• C++ Starter: A minimalistic GitHub repository template to kickstart your C++ project.
• Errors C++: A C++ package that provides utilities for error handling.
• Result: A simple C++ implementation of Rust Result, an alternative to Abseil Status.

CMake Projects

• CMake Starter: A minimalistic GitHub repository template to kickstart your CMake project.
• Assertion.cmake: A CMake module containing a collection of assertion functions for testing purposes.
• CheckWarning.cmake: Check for compiler warnings in your CMake project.
• FixFormat.cmake: Fix source codes formatting in your CMake project.
• GitCheckout.cmake: Clone and check out a Git repository from a CMake project.
• SetupGo.cmake: Set up a specific version of Go from a CMake project.

Node.js Projects

• Node.js Starter: A minimalistic GitHub repository template to kickstart your Node.js project.
• Google Rank: Retrieve the Google search ranking of your website for specific keywords.
• LeetTest: Tool for compiling and testing solutions to LeetCode problems.

GitHub Actions Projects

• Action Starter: A minimalistic GitHub repository template to kickstart your GitHub Action project.
• Setup Yarn Berry Action: Set up Yarn to a specified version and install Node.js project with cache support on GitHub Actions.
• Pipx Install Action: Install Python packages using pipx with cache support on GitHub Actions.
• CMake Action: Configure, build, and test your CMake project using GitHub Actions.
• Gcovr Action: Generate code coverage reports for a C++ project on GitHub Actions using gcovr.
• LeetTest Action: Compile and test solutions to LeetCode problems on GitHub Actions.

GitHub Composite Actions Projects

• Composite Action Starter: A minimalistic GitHub repository template to kickstart your GitHub composite action project.
• Setup Poetry Action: Set up your GitHub Actions workflow with a specific version of Poetry.
• CTest Action: Test CMake projects using CTest on GitHub Actions.
• ROS 2 Workspace Action: Setup, build and test a ROS 2 workspace using GitHub Actions.

Other Projects

• Project Starter: A minimalistic GitHub repository template to kickstart your project.
• Python Starter: A minimalistic GitHub repository template to kickstart your Python project.
• LeetSpace: A dedicated workspace and archive for my LeetCode submissions.

composite-action-starter's Issues

Initialize Example Composite Action

This issue proposes initializing a sample GitHub composite action for use in this template.

Run Workflow on Matrix with Multiple OSs

Suggesting to run the workflow on a matrix that includes three major operating systems: Windows, Ubuntu, and macOS.

Add Quick Usage to Readme

This issue suggests adding a quick usage guide to the README.md file. This change is proposed to make the template's usage accessible directly from the README, while keeping other usage information concise.

Rename GitHub Action Metadata File

This issue suggests renaming the GitHub action metadata file from action.yaml to action.yml. Refer to threeal/ctest-action#34 for more information and the rationale behind this change.

Remove Badges from Readme

This issue suggests removing badges from the README.md file because the information in the badges does not seem to be important to include in the readme. Refer to threeal/pipx-install-action#119 for more information and the rationale behind this proposal.

Simplify Readme

This issue suggests simplifying the content of the README.md file by modifying the description and the key features section to be more direct and clear.

Rename CI Workflow to Test Workflow

This issue suggests renaming the ci.yaml workflow to test.yaml workflow, consequently renaming the test job to test-action job. This change is proposed to align with the naming conventions used in the Action Starter template.

Refactor Branding Configuration in `action.yaml`.

This issue suggests refactoring the branding configuration in the action.yaml file by switching the position of the branding.color with the branding.icon as seen here:

composite-action-starter/action.yaml

Lines 7 to 9 in e2a6d6a

	branding:
	color: black
	icon: folder-plus

Sparse Checkout for Action Files in Workflow

This issue proposes modifying the test job in the ci.yaml workflow to perform a sparse checkout, focusing only on the necessary action files instead of the entire set of files when testing the action. See threeal/action-starter#116 for the rationale behind this proposal.