An open API service indexing awesome lists of open source software.

https://github.com/basher83/.github

Shared workflows repo
https://github.com/basher83/.github

Last synced: 4 months ago
JSON representation

Shared workflows repo

Awesome Lists containing this project

README

          

# ๐Ÿš€ Reusable GitHub Actions Workflows

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Workflows](https://img.shields.io/badge/Workflows-5-blue.svg)](#available-workflows)
[![Documentation](https://img.shields.io/badge/Docs-Complete-green.svg)](docs/)

This repository serves as a **central hub for reusable GitHub Actions workflows** that can be called from your other repositories. Standardize and simplify your CI/CD and automation across all your projects with battle-tested, production-ready workflows.

## ๐Ÿ“‹ Table of Contents

- [Quick Start](#-quick-start)
- [Available Workflows](#-available-workflows)
- [Repository Structure](#-repository-structure)
- [Documentation](#-documentation)
- [Contributing](#-contributing)

## ๐Ÿš€ Quick Start

### Using a Workflow in Your Repository

1. **Create a workflow file** in your repository (e.g., `.github/workflows/ci.yml`)
2. **Reference the reusable workflow** from this repository:

```yaml
name: CI Pipeline
on: [push, pull_request]

jobs:
quality-checks:
uses: basher83/.github/.github/workflows/python-quality.yml@main
with:
python-version: "3.12"
coverage-threshold: 80
```

3. **Customize parameters** as needed for your project
4. **Commit and push** - your workflow will run automatically!

### Available Workflows

| Workflow | Description | Status | Documentation |
|----------|-------------|--------|---------------|
| ๐Ÿท๏ธ **Sync Labels** | Synchronize repository labels from central config | โœ… Production | [docs/workflows/](docs/workflows/) |
| ๐Ÿ” **Tailscale Connect** | Connect GitHub runner to Tailscale tailnet | ๐Ÿงช Beta | [docs/workflows/](docs/workflows/) |
| ๐Ÿ **Python Quality** | Comprehensive Python linting and testing | ๐Ÿšง Planned | [docs/workflows/python.md](docs/workflows/python.md) |
| ๐ŸŽญ **Ansible Lint** | Ansible playbook validation and linting | ๐Ÿšง Planned | [docs/workflows/ansible.md](docs/workflows/ansible.md) |
| ๐Ÿณ **Docker Build** | Multi-platform Docker builds with security scanning | ๐Ÿšง Planned | [docs/workflows/docker.md](docs/workflows/docker.md) |

## ๐Ÿ“ Repository Structure

```
.github/
โ”œโ”€โ”€ workflows/ # Operational workflows (called by remote repos)
โ”œโ”€โ”€ use-workflows/ # Reference implementations for remote repos
โ””โ”€โ”€ workflow-templates/ # Organization-wide workflow templates

docs/
โ”œโ”€โ”€ getting-started.md # Comprehensive onboarding guide
โ”œโ”€โ”€ workflows/ # Individual workflow documentation
โ”œโ”€โ”€ examples/ # Practical usage examples
โ”œโ”€โ”€ CONTRIBUTING.md # Contribution guidelines
โ””โ”€โ”€ FAQ.md # Frequently asked questions
```

## ๐Ÿ“š Documentation

- **[Getting Started Guide](docs/getting-started.md)** - Complete onboarding for new users
- **[Workflow Documentation](docs/workflows/)** - Detailed guides for each workflow
- **[Usage Examples](docs/examples/)** - Real-world implementation examples
- **[Roadmap](ROADMAP.md)** - Project timeline and upcoming features
- **[Contributing](docs/CONTRIBUTING.md)** - How to contribute to this project
- **[FAQ](docs/FAQ.md)** - Common questions and troubleshooting

## ๐Ÿค Contributing

We welcome contributions! Please see our [Contributing Guide](docs/CONTRIBUTING.md) for details on:

- How to submit issues and feature requests
- Development workflow and coding standards
- Testing and documentation requirements

## ๐Ÿ“ˆ Roadmap

See our [detailed roadmap](ROADMAP.md) for upcoming features and current progress. We're continuously expanding our workflow collection to cover more technology stacks and use cases.

---

*Built with โค๏ธ to streamline CI/CD across all projects*