Skip to content

README.md

Latest commit

Β 

History

History
82 lines (61 loc) Β· 2.38 KB

README.md

File metadata and controls

82 lines (61 loc) Β· 2.38 KB

ARAS Workspace Organization Profile (.github) Repository

Organization profile and shared configurations for ARAS-Workspace.

Overview

This repository contains:

  • Organization Profile β€” Dynamic terminal animation displayed on the organization page
  • Workflows β€” GitHub Actions for automated content generation

Pipeline

flowchart TD
    T{"Trigger"} -->|push to main<br>or manual| A
    A["workspace-intro.sh<br>(Bash + GitHub API)"] -->|recording.cast| B
    B["asciinema rec<br>120 cols x 24 rows"] -->|recording.cast| C
    C["agg (Docker)<br>Solarized Dark, 1.5x, 15fps"] -->|assets/intro.gif| D
    D["git commit & push<br>github-actions bot"] --> E
    E["Organization Profile<br>github.com/ARAS-Workspace"]
Loading

Structure

.github/
β”œβ”€β”€ profile/
β”‚   └── README.md                ← Organization profile
β”œβ”€β”€ assets/
β”‚   └── intro.gif                ← Terminal animation (auto-generated)
β”œβ”€β”€ scripts/
β”‚   β”œβ”€β”€ workspace-intro.sh       ← Animation script
β”‚   └── runner-setup.sh          ← Runner setup script
└── .github/
    └── workflows/
        └── generate-intro.yml   ← Animation workflow

Configuration

Editable constants in scripts/workspace-intro.sh:

# GitHub
GITHUB_ORG="ARAS-Workspace"

# Domain & SSH
DOMAIN="aras.tc"
SSH_USER="workspace"
SSH_HOST="aras"
GUEST_USER="guest"
GUEST_HOST="local"

# Branding
AUTHOR_NAME="RΔ±za Emre ARAS"
AUTHOR_EMAIL="r.emrearas@proton.me"
SLOGAN="Turkish engineering, universal code."

# Animation Timing
TYPING_SPEED=0.05          # Base typing speed (seconds)
TYPING_VARIANCE=0.03       # Random variance per keystroke
COMMAND_PAUSE=0.4           # Pause after typing a command
LINE_PAUSE=0.2              # Pause between lines
SECTION_PAUSE=1.2           # Pause between sections

Workflow

The generate-intro.yml workflow records a terminal animation using asciinema and converts it to GIF using agg.

Triggers:

  • Manual dispatch
  • Changes to scripts/workspace-intro.sh

Output: assets/intro.gif

License

This project is licensed under the MIT License β€” see the LICENSE file for details.

Third-party software licenses are documented in THIRD_PARTY_LICENSES.