Commit graph

10 commits

Author SHA1 Message Date
02dd5a20bc **ci(workflows): add GitHub Pages workflow for demo deployment with custom domain**
### Changes:
- Introduced `deploy-demo.yml` workflow in `.github/workflows/` to automate deployment to GitHub Pages:
  - Triggers on `main` branch pushes and manual workflow dispatch.
  - Includes steps for project setup, build, and deployment using `JamesIves/github-pages-deploy-action`.
- Added `examples/CNAME` with custom domain `www.soulcraft.com`.

### Purpose:
Streamlined and automated the deployment of the demo to GitHub Pages, ensuring efficient updates. Configured a custom domain for better branding and accessibility of the live demo.
2025-06-20 14:36:35 -07:00
5cc6f9d683 **build(demo): remove GitHub Pages workflow and streamline demo deployment**
### Changes:
- Removed `github-pages.yml` GitHub Actions workflow file.
- Updated `README.md`:
  - Added documentation for `npm run deploy:demo` to deploy the demo to GitHub Pages.
  - Updated the live demo link to reflect the repository's namespace change.
- Added `gh-pages` dependency (v6.3.0) in `package.json`.
- Introduced `deploy:demo` script in `package.json` for demo deployment.

### Purpose:
Streamlined the demo deployment process by removing the dedicated GitHub Pages workflow and replacing it with a manual deployment script (`npm run deploy:demo`). This enhances developer control while maintaining simplicity in deploying updates to the live demo.
2025-06-20 14:23:30 -07:00
982609e001 **ci(workflows): downgrade upload-pages-artifact action to v2**
### Changes:
- **github-pages.yml**:
  - Downgraded `actions/upload-pages-artifact` from `v3` to `v2`.

### Purpose:
Reverted to `v2` of the `upload-pages-artifact` action to maintain compatibility with existing workflows or address potential issues introduced in `v3`.
2025-06-20 14:18:35 -07:00
0fec77057a **docs(readme): improve readability through line wrapping and formatting adjustments**
### Changes:
- Reformatted `README.md` for enhanced readability:
  - Applied line wrapping to long paragraphs and bullet points.
  - Adjusted spacing and indentation for consistent formatting.
  - Resolved issues with inconsistent code snippet alignments and metadata formatting.

### Purpose:
Improved the readability and maintainability of the README by standardizing formatting and wrapping long lines. These changes ensure better clarity for users exploring the documentation.
2025-06-20 14:16:15 -07:00
baf5e41877 Update github-pages.yml 2025-06-20 14:11:51 -07:00
e89fd8b7f6 **ci(workflows): update upload-pages-artifact action to v4**
### Changes:
- **github-pages.yml**:
  - Updated `actions/upload-pages-artifact` from `v3` to `v4`.

### Purpose:
Ensured compatibility with the latest version of the `upload-pages-artifact` action to leverage improvements and maintain long-term support.
2025-06-20 14:04:58 -07:00
b5d73a54bf **docs(readme): fix demo link and update GitHub Actions workflow versions**
### Changes:
- **README.md**: Corrected the relative path for the live demo link to `examples/demo.html`.
- **github-pages.yml**:
  - Updated GitHub Actions steps to their latest versions:
    - `actions/checkout@v4`
    - `actions/configure-pages@v4`
    - `actions/upload-pages-artifact@v3`
    - `actions/deploy-pages@v4`
  - Ensured compatibility with the latest versions of the workflow actions.

### Purpose:
Fixed a broken link in the README for better user accessibility to the demo. Updated workflow actions in `github-pages.yml` to leverage the latest performances and features.
2025-06-20 14:02:32 -07:00
3014a32e20 **ci(workflows): add GitHub Actions workflow for GitHub Pages deployment**
### Changes:
- Introduced a new `github-pages.yml` workflow in `.github/workflows/`.
- Configured the workflow to:
  - Trigger on pushes to the `main` branch.
  - Deploy files from the `./examples` directory to GitHub Pages.
  - Utilize Actions such as `checkout`, `configure-pages`, `upload-pages-artifact`, and `deploy-pages`.
- Set up necessary permissions for deploying to GitHub Pages.

### Purpose:
Added an automated GitHub Actions workflow to streamline the deployment of content to GitHub Pages. This ensures a consistent and efficient process for updating the demo or documentation hosted online.
2025-06-20 13:50:25 -07:00
5566ddfb09 chore: remove example files and release configuration
Deleted augmentation pipeline examples and `.releaserc.json`, streamlining the repository by eliminating redundant example implementations and release automation files.
2025-05-27 13:58:49 -07:00
022680a2f5 feat: implement augmentation type system and release automation 2025-05-27 13:12:53 -07:00