Docs deploy workflow fix

[jbdevprimary]

Pull Request

Summary

Fixes the Deploy Documentation to Pages GitHub Actions workflow and updates documentation content placeholders.

Related Issues

• Closes Fix Deploy Documentation to Pages workflow #6
• Fixes #
• Relates to #

Type of Change

• 🐛 Bug fix (non-breaking change which fixes an issue)
• ✨ New feature (non-breaking change which adds functionality)
• 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
• 📝 Documentation update
• ♻️ Code refactoring
• ⚡ Performance improvement
• ✅ Test update
• 🔧 Configuration/build change

Changes Made

• Updated .github/workflows/docs.yml:
  • Added pull_request trigger to validate documentation builds on PRs.
  • Upgraded Python version to 3.13.
  • Switched to hynek/setup-cached-uv for improved caching and build speed.
  • Ensured correct pages: write and id-token: write permissions.
  • Added conditional guards to ensure deployment steps only run on main branch pushes.
• Replaced PACKAGE_NAME placeholders: Updated all instances of PACKAGE_NAME with extended-data-types (for repo/project name) or extended_data_types (for Python imports) across documentation files (index.rst, modules.rst, installation.md, quickstart.md, contributing.md).
• Added docs/_build/ to .gitignore: Prevents documentation build artifacts from being committed.

Testing

• Unit tests added/updated
• Integration tests added/updated
• E2E tests added/updated
• Manual testing performed

Test Details

• Verified that core CI (tests and linting) passes locally using uv run pytest and uvx ruff.
• The workflow changes will be validated by the GitHub Actions run on this PR.

Self-Review Checklist

Code Quality

• Code follows project style guidelines
• No linting errors
• Code is properly formatted
• Type checking passes (if applicable)
• Self-reviewed code for logic errors

Testing

• All new code is covered by tests
• All tests pass locally
• Edge cases are tested
• Error cases are tested

Documentation

• Comments added for public APIs
• Complex logic is commented
• README updated (if needed)

Commits

• Commits follow conventional commit format
• Commit messages are clear and descriptive

Screenshots/Videos

Additional Notes

---

 

---

Note

Ensures reliable docs builds and guarded deployments, and aligns docs with the actual package name.

• GitHub Actions docs.yml: add pull_request trigger; upgrade to Python 3.13; switch to hynek/setup-cached-uv; gate configure-pages, artifact upload, and deploy to only run on push to main.
• Documentation: replace PACKAGE_NAME with extended-data-types / extended_data_types; update index.rst, API index.rst and modules.rst, installation/quickstart examples, and contributing guide.
• Add docs/_build/ to .gitignore to exclude Sphinx build artifacts.

^{Written by Cursor Bugbot for commit 76842fc. This will update automatically on new commits. Configure here.}

[cursor]

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
_{Learn more about Cursor Agents}

[gemini-code-assist]

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

[amazon-q-developer]

Review Summary

This PR successfully addresses the documentation workflow issues and placeholder replacements. The changes are well-structured and implement proper CI/CD practices.

✅ Approved Changes

GitHub Actions Workflow Improvements:

• ✅ Added pull_request trigger for documentation build validation
• ✅ Upgraded Python version from 3.12 to 3.13 (supported in pyproject.toml)
• ✅ Switched to hynek/setup-cached-uv@v2 for better caching and performance
• ✅ Proper conditional deployment guards ensuring Pages deployment only occurs on main branch pushes
• ✅ Correct permissions configuration (pages: write, id-token: write)

Documentation Updates:

• ✅ Systematic replacement of PACKAGE_NAME placeholders with correct values:
  • extended-data-types for repository/project references
  • extended_data_types for Python import statements
• ✅ Updated quickstart example uses valid json_utils.encode_json function (verified in __init__.py)
• ✅ Consistent documentation structure maintained across all files

Infrastructure:

• ✅ Added docs/_build/ to .gitignore to prevent build artifacts from being committed

🎯 Key Strengths

1. Proper CI/CD Design: The workflow now validates documentation builds on PRs while only deploying from main branch
2. Version Compatibility: Python 3.13 upgrade is properly supported by the project configuration
3. Performance Optimization: Using cached uv setup will improve build times
4. Code Accuracy: Documentation examples reference actual exported functions from the package

📋 Summary

This PR effectively resolves issue #6 by fixing the documentation deployment workflow and replacing all placeholder content with accurate project-specific information. The implementation follows GitHub Actions best practices and maintains proper separation between validation (PRs) and deployment (main branch only).

Recommendation: ✅ APPROVE - Ready for merge.

---

You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.

[cursor]

Manual workflow dispatch cannot trigger deployment

The workflow_dispatch trigger is included in the workflow, but the conditional guards on the Setup Pages, Upload artifact, and deploy job only check for github.event_name == 'push'. When manually triggered via workflow_dispatch, the event name is 'workflow_dispatch', causing all deployment steps to be skipped. This breaks the ability to manually deploy documentation. The condition needs to also include github.event_name == 'workflow_dispatch' for manual deploys to work.

Additional Locations (1)

• .github/workflows/docs.yml#L7-L8