Skip to content

null-charge/actions

Folders and files

NameName
Last commit message
Last commit date

Latest commit

5ff000a · Jul 1, 2024

History

10 Commits
Jul 1, 2024
Jun 30, 2024

Repository files navigation

Reusable Actions Repository

Welcome to our Reusable Actions Repository This repository serves as a central hub for developing, maintaining, and sharing reusable workflows and composite actions designed to streamline and enhance software development processes across projects. Our goal is to foster efficiency, collaboration, and best practices within the GitHub Actions ecosystem.

What We Offer

  • Reusable Workflows: Predefined workflows that encapsulate entire CI/CD processes, enabling rapid deployment and consistency across multiple repositories. These workflows are designed to be versatile and adaptable to various project needs.
  • Composite Actions: Custom actions that bundle together sequences of steps commonly used in workflows. These actions simplify workflow definitions and promote code reuse, making your CI/CD pipelines more manageable and understandable.

Best Practices

To ensure the quality and usability of our reusable actions, we adhere to several best practices:

  • Parameterization: Our workflows and actions are parameterized to offer flexibility and customization according to specific project requirements.
  • Documentation: Comprehensive documentation accompanies each workflow and action, detailing usage, parameters, and examples to facilitate easy integration.
  • Versioning: We version our reusable workflows and actions to maintain compatibility and allow for incremental improvements over time.
  • Testing: Rigorous testing is conducted to guarantee reliability and performance under different scenarios and environments.
  • Naming Conventions: Consistent naming conventions are followed to ensure clarity and ease of identification.

Getting Started

To utilize our reusable actions in your projects, simply reference them in your workflow files using the uses keyword. For example:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Run Custom Composite Action
        uses: our-org/reusable-actions-repo/.github/actions/custom-composite-action@main

Contribution Guidelines

We welcome contributions from the community Whether it's adding new actions, improving existing ones, or suggesting enhancements, your input is invaluable. Please refer to our CONTRIBUTING.md for guidelines on submitting pull requests and issues.

Contact Us

For inquiries, support, or feedback, please reach out to us via GitHub Discussions or by opening an issue in this repository.