Skip to content

Getting Started

To get started with using reusable workflows in your repository, follow these steps:

  1. Create a .github/workflows directory in your repository if it doesn't already exist. This is where all your workflow files will be stored.

  2. Choose an Example Workflow Browse the docs/examples/ folder in the reusable workflows repository and select an example workflow that suits your needs. Copy the file into your .github/workflows directory.

  3. Open the copied workflow file and tailor it to your project. Each workflow includes a set of jobs that define tasks to be executed. Adjust these tasks, steps, and settings as needed.

  4. Ensure all required inputs are set correctly. These inputs may include environment variables, AWS credentials, or Docker image details. The workflow file will specify which inputs are necessary, and you can modify them to match your project’s requirements.

  5. Once you've customized the workflow, commit and push your changes to the repository.

  6. The workflow will automatically run based on the event triggers defined in the file (e.g., push, pull_request). Ensure the events are configured as needed for your use case.

That's it! You have successfully set up and customized a reusable workflow in your repository. Now you can benefit from the predefined tasks and automation provided by the workflow to streamline your development process.

Deploy workflows through Tam CLI tool

Generic workflows can be seamlessly deployed to your repository using the Tam CLI tool. This tool simplifies the process by automatically creating a pull request in your repository, ensuring that all required inputs and GitHub environments are generated and configured for you. Tam CLI leverages templates defined in the Templates repository. For more details refer to the Tam CLI page.