# cncf-calendar

**Repository Path**: cncf/cncf-calendar

## Basic Information

- **Project Name**: cncf-calendar
- **Description**: CNCF Calendar
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-03
- **Last Updated**: 2025-12-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CNCF Calendar

A GitHub Action and static site generator for listing CNCF (Cloud Native Computing Foundation) projects and their calendars, grouped by category, with a search interface.

## Overview

This project fetches project data from the Linux Foundation API and generates a modern, searchable HTML page listing CNCF projects by category (TAG, Graduated, Incubating, Sandbox, and Forming). Each project entry includes its logo, name, calendar link, and repository link (if available).

The generated site is suitable for publishing as a GitHub Pages site or for use in other static hosting environments.

## Features
- **Automated Data Fetching:** Uses the LFX API to retrieve up-to-date CNCF project information.
- **Categorized Listing:** Projects are grouped and sorted by their CNCF category.
- **Forming Projects:** Special section for projects in the "Formation - Exploratory" state.
- **Modern UI:** Clean, responsive HTML with a search box for filtering projects.
- **Easy Integration:** Designed for use in CI/CD pipelines (e.g., GitHub Actions).

## Usage

### Prerequisites
- **jq**: Command-line JSON processor (required by the script)
- **curl**: For API requests
- **Bash**: The script uses bash-specific features
- **LFX_TOKEN**: You must provide a valid LFX API token as an environment variable

### Running the Script

1. **Set the LFX_TOKEN environment variable:**
   ```sh
   export LFX_TOKEN=your_lfx_api_token_here
   ```
2. **Run the script:**
   ```sh
   bash calendar_update/entrypoint.sh
   ```
   The script will generate an `index.html` file in the repository root (or in the directory specified by `$GITHUB_WORKSPACE`).

### GitHub Actions
This script is designed to be used as part of a GitHub Action workflow. Ensure your workflow sets the `LFX_TOKEN` secret and checks out the repository.

## File Structure
- `calendar_update/entrypoint.sh`: Main script for fetching data and generating HTML
- `index.html`: Output file with the project calendar listing
- `calendar_update/action.yaml`: (If present) GitHub Action metadata

## Customization
- **Foundation ID:** The script is set up for CNCF by default. To use for another foundation, change the `FOUNDATION_ID` variable in the script.
- **Styling:** Edit the HTML/CSS in the script for custom branding or layout.

## Contributing
Pull requests and issues are welcome! Please ensure your code is well-commented and tested.

## License
[Apache-2.0](LICENSE)