Redirecting to API Documentation...
+ + + EOF + fi + + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v4 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./deploy + keep_files: true + commit_message: 'Deploy documentation from ${{ github.sha }}' diff --git a/.github/workflows/sync-docs.yml b/.github/workflows/sync-docs.yml new file mode 100644 index 000000000..31fe83318 --- /dev/null +++ b/.github/workflows/sync-docs.yml @@ -0,0 +1,113 @@ +name: Sync Documentation to gh-pages + +on: + push: + branches: [master, develop] + paths: + - 'doc/html/**' + - 'angular/doc/**' + - '.github/workflows/sync-docs.yml' + workflow_dispatch: + +jobs: + sync-docs: + runs-on: ubuntu-latest + if: github.repository == 'gridstack/gridstack.js' + + steps: + - name: Checkout master branch + uses: actions/checkout@v4 + with: + ref: master + fetch-depth: 0 + token: ${{ secrets.GITHUB_TOKEN }} + + - name: Configure Git + run: | + git config --global user.name 'github-actions[bot]' + git config --global user.email 'github-actions[bot]@users.noreply.github.com' + + - name: Check if docs exist + id: check-docs + run: | + if [ -d "doc/html" ]; then + echo "main_docs=true" >> $GITHUB_OUTPUT + else + echo "main_docs=false" >> $GITHUB_OUTPUT + fi + + if [ -d "angular/doc/api" ]; then + echo "angular_docs=true" >> $GITHUB_OUTPUT + else + echo "angular_docs=false" >> $GITHUB_OUTPUT + fi + + - name: Checkout gh-pages branch + if: steps.check-docs.outputs.main_docs == 'true' || steps.check-docs.outputs.angular_docs == 'true' + run: | + git fetch origin gh-pages + git checkout gh-pages + + - name: Sync main library documentation + if: steps.check-docs.outputs.main_docs == 'true' + run: | + echo "Syncing main library documentation..." + + # Remove existing docs directory if it exists + if [ -d "docs/html" ]; then + rm -rf docs/html + fi + + # Extract docs from master branch using git archive + mkdir -p docs + git archive master doc/html | tar -xf - + mv doc/html docs/html + rm -rf doc + + # Add changes + git add docs/html + + - name: Sync Angular documentation + if: steps.check-docs.outputs.angular_docs == 'true' + run: | + echo "Syncing Angular library documentation..." + + # Remove existing Angular docs if they exist + if [ -d "angular/doc" ]; then + rm -rf angular/doc + fi + + # Extract Angular docs from master branch using git archive + git archive master angular/doc | tar -xf - + + # Add changes + git add angular/doc + + - name: Commit and push changes + if: steps.check-docs.outputs.main_docs == 'true' || steps.check-docs.outputs.angular_docs == 'true' + run: | + # Check if there are changes to commit + if git diff --staged --quiet; then + echo "No documentation changes to sync" + exit 0 + fi + + # Create commit message + COMMIT_MSG="📚 Auto-sync documentation from master" + if [ "${{ steps.check-docs.outputs.main_docs }}" == "true" ]; then + COMMIT_MSG="${COMMIT_MSG}%0A%0A- Updated main library HTML docs (docs/html/)" + fi + if [ "${{ steps.check-docs.outputs.angular_docs }}" == "true" ]; then + COMMIT_MSG="${COMMIT_MSG}%0A%0A- Updated Angular library docs (angular/doc/)" + fi + + COMMIT_MSG="${COMMIT_MSG}%0A%0ASource: ${{ github.sha }}" + + # Decode URL-encoded newlines for the commit message + COMMIT_MSG=$(echo -e "${COMMIT_MSG//%0A/\\n}") + + # Commit and push + git commit -m "$COMMIT_MSG" + git push origin gh-pages + + echo "✅ Documentation synced to gh-pages successfully!" diff --git a/.gitignore b/.gitignore index d58eb8745..1451f9e98 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,5 @@ dist_save node_modules .vscode .idea/ +.DS_Store +doc/html/ diff --git a/.vitestrc.coverage.ts b/.vitestrc.coverage.ts new file mode 100644 index 000000000..4c8b203dd --- /dev/null +++ b/.vitestrc.coverage.ts @@ -0,0 +1,131 @@ +///