Adding GitHub Page site generation (#11)
Commit: 7e81a579339ffe38a9beba0efa6af5921423385e
Date: 2025-07-02 18:11:37 +0200
Author: PascalHavelange
Commit Message
Adding GitHub Page site generation (#11)
* fix: Convert blog post generation script to ES modules (#2)
- Update scripts/generate-blog-posts.js to use import statements instead of require()
- Fix ReferenceError in GitHub Pages pipeline caused by CommonJS syntax in ES module project
- Remove PR-DESCRIPTION.md file (already in .gitignore)
- Generated test blog posts to verify functionality
Fixes the blog post generation workflow that was failing with:
'ReferenceError: require is not defined in ES module scope'
Co-authored-by: Pascal HAVELANGE <havelangep@hotmail.com>
* fix: Deploy GitHub Pages to gh-pages branch instead of main (#3)
- Use peaceiris/actions-gh-pages action to deploy to gh-pages branch
- Remove requirement for write permissions to main branch
- Keep generated blog posts separate from main branch source code
- Simplify permissions to contents: read (no longer need write access)
- Build and deploy from gh-pages branch instead of main
This prevents polluting the main branch with generated files and follows
GitHub Pages best practices by using a dedicated branch for deployment.
Co-authored-by: Pascal HAVELANGE <havelangep@hotmail.com>
* fix: Deploy GitHub Pages to gh-pages branch instead of main (#4)
- Use peaceiris/actions-gh-pages action to deploy to gh-pages branch
- Remove requirement for write permissions to main branch
- Keep generated blog posts separate from main branch source code
- Simplify permissions to contents: read (no longer need write access)
- Build and deploy from gh-pages branch instead of main
This prevents polluting the main branch with generated files and follows
GitHub Pages best practices by using a dedicated branch for deployment.
Co-authored-by: Pascal HAVELANGE <havelangep@hotmail.com>
* Fix GitHub Pages workflow: remove problematic git commands (#5)
* Fix GitHub Pages workflow: remove problematic git commands
- Simplify workflow to single job that generates blog posts and deploys
- Remove complex git branch manipulation causing pathspec errors
- Use standard GitHub Actions Pages deployment pattern
- Eliminates 'pathspec gh-pages did not match any file(s) known to git' error
* Simplify GitHub Pages deployment workflow
- Remove complex gh-pages branch switching logic
- Use standard Jekyll build and deploy actions
- Keep blog post generation but simplify the deployment process
- Fix pathspec error by avoiding manual branch operations
---------
Co-authored-by: Pascal HAVELANGE <havelangep@hotmail.com>
* docs: update documentation with current requirements and GitHub CLI workflow (#6)
- Update Node.js requirement from 22.17.0+ and npm from 10.9.2+ across all docs
- Update TESTING.md CI configuration to use Node.js 22
- Add comprehensive GitHub CLI guide to contributing.md with auto-merge and squash instructions
- Update docs/README.md to reflect actual GitHub Pages workflow implementation
- Remove references to non-existent scripts/generate-blog-posts.js
- Clean up outdated blog posts and configuration files
- Improve documentation accuracy for current project state
Co-authored-by: Pascal HAVELANGE <havelangep@hotmail.com>
* fix: correct repository name typo from 'inventoy' to 'inventory' (#7)
- Fixed repository name in GitHub workflow deploy-pages.yml
- Updated Jekyll _config.yml with correct repository URLs
- Corrected baseurl path in configuration files
Co-authored-by: Pascal HAVELANGE <havelangep@hotmail.com>
* Fix github repo url (#8)
Co-authored-by: Pascal HAVELANGE <havelangep@hotmail.com>
* docs: Update documentation website with improved structure and guidelines (#10)
* docs: Update documentation website with improved structure and guidelines
- Restructured documentation with comprehensive guidelines
- Added API integration documentation
- Added testing documentation
- Added coding guidelines
- Updated Jekyll configuration for better organization
- Added commit documentation generation scripts
- Improved contributing guidelines
- Added development archive documentation
- Removed outdated deployment workflow
- Enhanced site structure with proper layouts and navigation
* remove test-docs.yml workflow pipeline
---------
Co-authored-by: Pascal HAVELANGE <havelangep@hotmail.com>
* feat: add GitHub workflow for automatic commit documentation generation
* fix: update commit documentation generation scripts
* fix: correct working directory and paths in commit documentation workflow
* fix: configure GitHub Pages workflow for proper recognition
- Add github-pages environment to job
- Add workflow-level permissions and concurrency control
- Include actions/configure-pages@v4 step
- Add deployment step ID for URL output
- Ensure GitHub recognizes this as a Pages deployment workflow
* fix: resolve GitHub Action issue with commit documentation generation
- Fixed log file path in Python script (LOG_FILE = 'docs/commit-docs.log')
- Removed _docs/ from docs/.gitignore to allow Git tracking of generated files
- Updated GitHub Action workflow to stage files before checking for changes
- Added docs/commit-docs.log to main .gitignore
- Updated PowerShell script for consistency
Fixes the issue where GitHub Action was not detecting generated documentation files.
* fix: remove git diff checks from generate-commit-docs workflow
- Remove conditional checks that referenced non-existent check_changes step
- Simplify workflow to always build and deploy documentation
- Fix workflow structure with proper build/deploy separation
* fix: remove Gemfile.lock from repository and add to .gitignore to prevent frozen mode issues in GitHub Actions
* fix: Correct hyperlinks in GitHub Pages generation
- Fix hyperlinks in docs/index.md
- Fix hyperlinks in docs/guidelines/*.md
- Add docs/guidelines/generate-commit-docs.md describing the documentation generation
---------
Co-authored-by: Pascal HAVELANGE <havelangep@hotmail.com>
Files Changed
- 📝 Modified:
.github/copilot-instructions.md
- ❌ Deleted:
.github/workflows/deploy-pages.yml
- ✅ Added:
.github/workflows/generate-commit-docs.yml
- ❌ Deleted:
.github/workflows/test-docs.yml
- 📝 Modified:
.gitignore
- ❌ Deleted:
PR-DESCRIPTION.md
- 📝 Modified:
README.md
- ✅ Added:
docs/.copilot-instructions.md
- ✅ Added:
docs/.github/workflows/generate-commit-docs.yml
- ✅ Added:
docs/.gitignore
- 📝 Modified:
docs/Gemfile
- ✅ Added:
docs/Gemfile.lock
- 📝 Modified:
docs/README.md
- 📝 Modified:
docs/_config.yml
- ✅ Added:
docs/_docs/.gitignore
- ✅ Added:
docs/_layouts/default.html
- 📝 Modified:
docs/contributing.md
- 🔄 Renamed:
docs/blog.md docs/development-archive.md
- ✅ Added:
docs/generate-commit-docs.ps1
- ✅ Added:
docs/generate-commit-docs.py
- 🔄 Renamed:
docs/api-integration.md docs/guidelines/api-integration.md
- ✅ Added:
docs/guidelines/coding-guidelines.md
- ✅ Added:
docs/guidelines/generate-commit-docs.md
- ✅ Added:
docs/guidelines/index.md
- 🔄 Renamed:
docs/integration-testing.md docs/guidelines/integration-testing.md
- 🔄 Renamed:
docs/TESTING.md docs/guidelines/testing.md
- 📝 Modified:
docs/index.md
- ❌ Deleted:
scripts/generate-blog-posts.js
Links
This documentation was automatically generated from Git commit data.