How tetsuya81/github-workflow-training-ojt01 works
Project & Purpose Overview
• This repository is designed as an OJT manual for beginners learning GitHub workflows, including issue management, branching strategy, pull requests, and GitHub Actions.
• The core application is a lightweight web-based TODO app built with HTML, CSS, and JavaScript.
• The project also demonstrates effective CI/CD through GitHub Actions and a structured branching strategy based on GitFlow.
Analyzing the File Structure
• .github directory: Contains both Issue Templates and workflow files (ci.yml and release.yml). This indicates that automated testing, linting, and release processes are being managed via GitHub Actions.
• src directory: Hosts the client-side files (index.html, style.css, app.js), which form the actual TODO application.
• tests directory: Contains testing code (using Jest), showing that automated tests are part of the project’s workflow.
• Other files like package.json (with dependencies for serve, eslint, and jest) and LICENSE, README.md, and documentation (doc/manual.md) provide context on dependencies and the project's training goals.
Key Components
a. Frontend Application:
• Client’s browser as the user interface.
• Components for index.html, style.css, and app.js that define the UI, styling, and application logic.
b. Testing Component:
c. CI/CD & Automation:
• GitHub Actions workflows (CI workflow in ci.yml and the Release workflow in release.yml) that handle integration tasks (linting, testing, building) and releases.
d. Issue Management and Version Control:
• GitHub's role in issue tracking (via .github/ISSUE_TEMPLATE) and branch management (using GitFlow branch naming and the pull request process described in the README).
e. Package & Dependency Management:
• A component for Node and npm, referencing package.json and package-lock.json, which drive dependency installation and serve commands.
Representing Relationships and Interactions
– Developers commit changes (to branches such as feature, bugfix, release, etc.)
– These changes trigger GitHub Actions workflows for CI (automated testing and linting) and eventually for creating releases.
– Issues (and PRs) serve as the inputs guiding feature development, bug fixes, and documentation.
• How the frontend interacts with the browser (user interface) and how the automated tests validate functionality before deployment.
• Interaction between local development (code in src and tests) and remote workflows in GitHub.
Architectural Patterns and Design Principles
• Even though the application is a simple static web app, the repository exemplifies a layered development workflow:
• Presentation Layer: Frontend (HTML/CSS/JS in src)
• Testing Layer: Automated tests in tests (Jest)
• Automation/CI Layer: GitHub Actions managing CI/CD / Deployment (workflows)
• Release & Issue Management: GitHub’s integrated Issue templates and branching strategies.
• Separation of concerns between the application logic (app.js), styling (style.css), and content (index.html), as well as distinguishing between the development process (branching, PR, issues) and CI/CD pipelines.