Skip to content

chore(release): release v1.0.1 - #2

Merged
rcpthongta merged 158 commits into
mainfrom
develop
Sep 23, 2026
Merged

rcpthongta merged 158 commits into
mainfrom
develop

Conversation

@rcpthongta

Copy link
Copy Markdown
Owner

Release v1.0.1

This PR merges documentation website implementation, GitHub Pages deployment automation, and metadata updates from develop into main for the v1.0.1 release of @rcpthongta/string-utils.

Summary of Changes

  • Documentation Website (VitePress):
    • Interactive documentation website powered by VitePress deployed to GitHub Pages
    • Dedicated Getting Started and Installation guides with CDN/IIFE, ESM, and CommonJS examples
    • Comprehensive API reference pages for all 16 utility modules and exported types
    • Standardized parameter tables, options breakdowns, return types, and empty/null/undefined edge-case examples
    • Built-in local search, custom brand theme styling, and responsive layout
  • CI/CD & Automation:
    • Automated GitHub Pages deployment job in .github/workflows/release.yml triggered after successful npm publishing
    • Configured VitePress build and cache ignore patterns in .gitignore and eslint.config.mjs
  • Package & Metadata:
    • Added homepage URL to package.json pointing to the official documentation website
    • Updated README.md with links to the live documentation website and formatted examples
    • Bumped package version to 1.0.1 in package.json and package-lock.json

Release Checklist

  • All 340 unit tests passing with high coverage
  • Production bundles build cleanly
  • Documentation site builds successfully without errors (npm run docs:build)
  • Version bumped to 1.0.1 in package.json and package-lock.json
  • CHANGELOG.md updated for v1.0.1
  • GitHub Pages deployment workflow configured in release.yml

@rcpthongta rcpthongta self-assigned this Sep 23, 2026
@rcpthongta rcpthongta added the release Pull requests that release a new version of the package label Sep 23, 2026
@rcpthongta
rcpthongta merged commit 35f0d13 into main Sep 23, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release Pull requests that release a new version of the package

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant