From 3c9342a7feef833fc17e1224305315b889cc229b Mon Sep 17 00:00:00 2001 From: Kenneth Belitzky Date: Tue, 5 Aug 2025 23:13:29 +0000 Subject: [PATCH 1/3] deploy to netlify --- .../{deploy-pages.yml => deploy-site.yml} | 24 +++++--- mkdocs.yml | 2 +- site/index.html | 12 ++-- site/manifest.json | 4 +- site/robots.txt | 2 +- site/sitemap.xml | 58 +++++++++---------- site/structured-data.json | 8 +-- site/update-sitemap.sh | 2 +- 8 files changed, 60 insertions(+), 52 deletions(-) rename .github/workflows/{deploy-pages.yml => deploy-site.yml} (62%) diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-site.yml similarity index 62% rename from .github/workflows/deploy-pages.yml rename to .github/workflows/deploy-site.yml index c02ee72..cac9e26 100644 --- a/.github/workflows/deploy-pages.yml +++ b/.github/workflows/deploy-site.yml @@ -1,4 +1,4 @@ -name: deploy-pages +name: deploy-site on: push: @@ -17,7 +17,7 @@ permissions: id-token: write concurrency: - group: "pages" + group: "site" cancel-in-progress: false jobs: @@ -46,14 +46,22 @@ jobs: run: | mkdocs build - - name: Setup Pages - uses: actions/configure-pages@v5 - - name: Upload artifact uses: actions/upload-pages-artifact@v3 with: path: './site' - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v4 + - name: Deploy to Netlify + uses: nwtgck/actions-netlify@v3.0 + with: + publish-dir: './site' + production-branch: main + github-token: ${{ secrets.GITHUB_TOKEN }} + deploy-message: "Deploy from GitHub Actions" + enable-pull-request-comment: true + enable-commit-comment: true + overwrites-pull-request-comment: true + env: + NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} + NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }} + timeout-minutes: 1 diff --git a/mkdocs.yml b/mkdocs.yml index 4d5bc26..df270ce 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ site_name: STRUCT Documentation site_description: Automated Project Structure Generator -site_url: https://httpdss.github.io/struct/ +site_url: https://structio.netlify.app/ repo_url: https://github.com/httpdss/struct repo_name: httpdss/struct diff --git a/site/index.html b/site/index.html index 1f1587a..8eea93e 100644 --- a/site/index.html +++ b/site/index.html @@ -21,17 +21,17 @@ - + - + - + - + @@ -48,7 +48,7 @@ - + @@ -78,7 +78,7 @@ "programmingLanguage": "Python", "downloadUrl": "https://github.com/httpdss/struct", "codeRepository": "https://github.com/httpdss/struct", - "url": "https://httpdss.github.io/struct/", + "url": "https://structio.netlify.app/", "author": { "@type": "Organization", "name": "httpdss", diff --git a/site/manifest.json b/site/manifest.json index ce7945b..6649028 100644 --- a/site/manifest.json +++ b/site/manifest.json @@ -59,7 +59,7 @@ "name": "Documentation", "short_name": "Docs", "description": "Read STRUCT documentation", - "url": "https://httpdss.github.io/struct/docs", + "url": "https://structio.netlify.app/docs", "icons": [ { "src": "/struct/images/docs-icon.png", @@ -71,7 +71,7 @@ "name": "Quick Start", "short_name": "Start", "description": "Quick start guide", - "url": "https://httpdss.github.io/struct/docs/quickstart", + "url": "https://structio.netlify.app/docs/quickstart", "icons": [ { "src": "/struct/images/quickstart-icon.png", diff --git a/site/robots.txt b/site/robots.txt index 7ce1dd3..2ceabd7 100644 --- a/site/robots.txt +++ b/site/robots.txt @@ -1,7 +1,7 @@ User-agent: * Allow: / -Sitemap: https://httpdss.github.io/struct/sitemap.xml +Sitemap: https://structio.netlify.app/sitemap.xml # Disallow crawling of demo source files Disallow: /demos/*.tape diff --git a/site/sitemap.xml b/site/sitemap.xml index 773ff5c..42c28a7 100644 --- a/site/sitemap.xml +++ b/site/sitemap.xml @@ -4,38 +4,38 @@ - https://httpdss.github.io/struct/ + https://structio.netlify.app/ 2025-07-28 weekly 1.0 - https://httpdss.github.io/struct/demos/basic-usage.gif + https://structio.netlify.app/demos/basic-usage.gif STRUCT Basic Usage Demo Basic Project Generation with STRUCT - https://httpdss.github.io/struct/demos/yaml-config.gif + https://structio.netlify.app/demos/yaml-config.gif STRUCT YAML Configuration Demo YAML Configuration Creation - https://httpdss.github.io/struct/demos/mappings-demo.gif + https://structio.netlify.app/demos/mappings-demo.gif STRUCT Mappings Demo External Mappings Usage - https://httpdss.github.io/struct/demos/remote-content.gif + https://structio.netlify.app/demos/remote-content.gif STRUCT Remote Content Demo Remote Content Fetching - https://httpdss.github.io/struct/demos/advanced-features.gif + https://structio.netlify.app/demos/advanced-features.gif STRUCT Advanced Features Demo Advanced Features and Hooks @@ -44,147 +44,147 @@ - https://httpdss.github.io/struct/docs/configuration + https://structio.netlify.app/docs/configuration 2025-08-02 weekly 0.8 - https://httpdss.github.io/struct/docs/hooks + https://structio.netlify.app/docs/hooks 2025-08-02 weekly 0.8 - https://httpdss.github.io/struct/docs/development + https://structio.netlify.app/docs/development 2025-08-02 weekly 0.8 - https://httpdss.github.io/struct/docs/vhs/index.html + https://structio.netlify.app/docs/vhs/index.html 2025-08-02 weekly 0.8 - https://httpdss.github.io/struct/docs/template-vriables + https://structio.netlify.app/docs/template-vriables 2025-08-02 weekly 0.8 - https://httpdss.github.io/struct/docs/known-issues + https://structio.netlify.app/docs/known-issues 2025-08-02 weekly 0.8 - https://httpdss.github.io/struct/docs/articles + https://structio.netlify.app/docs/articles 2025-08-02 weekly 0.8 - https://httpdss.github.io/struct/docs/404 + https://structio.netlify.app/docs/404 2025-08-02 weekly 0.8 - https://httpdss.github.io/struct/docs/installtion + https://structio.netlify.app/docs/installtion 2025-08-02 weekly 0.8 - https://httpdss.github.io/struct/docs/schema + https://structio.netlify.app/docs/schema 2025-08-02 weekly 0.8 - https://httpdss.github.io/struct/docs/usage + https://structio.netlify.app/docs/usage 2025-08-02 weekly 0.8 - https://httpdss.github.io/struct/docs/completion + https://structio.netlify.app/docs/completion 2025-08-02 weekly 0.8 - https://httpdss.github.io/struct/docs/structures + https://structio.netlify.app/docs/structures 2025-08-02 weekly 0.8 - https://httpdss.github.io/struct/docs/contributing + https://structio.netlify.app/docs/contributing 2025-08-02 weekly 0.8 - https://httpdss.github.io/struct/docs/github-integration + https://structio.netlify.app/docs/github-integration 2025-08-02 weekly 0.8 - https://httpdss.github.io/struct/docs/examples/index.html + https://structio.netlify.app/docs/examples/index.html 2025-08-02 weekly 0.8 - https://httpdss.github.io/struct/docs/file-handling + https://structio.netlify.app/docs/file-handling 2025-08-02 weekly 0.8 - https://httpdss.github.io/struct/docs/ + https://structio.netlify.app/docs/ 2025-08-02 weekly 0.8 - https://httpdss.github.io/struct/docs/mappings + https://structio.netlify.app/docs/mappings 2025-08-02 weekly 0.8 - https://httpdss.github.io/struct/docs/quickstart + https://structio.netlify.app/docs/quickstart 2025-08-02 weekly 0.8 - https://httpdss.github.io/struct/docs/funding + https://structio.netlify.app/docs/funding 2025-08-02 weekly 0.8 @@ -192,14 +192,14 @@ - https://httpdss.github.io/struct/docs/cli-reference + https://structio.netlify.app/docs/cli-reference 2025-08-02 weekly 0.9 - https://httpdss.github.io/struct/docs/custom-structures + https://structio.netlify.app/docs/custom-structures 2025-08-02 weekly 0.9 diff --git a/site/structured-data.json b/site/structured-data.json index f446be6..485704c 100644 --- a/site/structured-data.json +++ b/site/structured-data.json @@ -9,7 +9,7 @@ "programmingLanguage": "Python", "downloadUrl": "https://github.com/httpdss/struct", "codeRepository": "https://github.com/httpdss/struct", - "url": "https://httpdss.github.io/struct/", + "url": "https://structio.netlify.app/", "author": { "@type": "Organization", "name": "httpdss", @@ -41,7 +41,7 @@ }, "softwareVersion": "1.0", "releaseNotes": "Initial release with YAML-based project structure generation", - "screenshot": "https://httpdss.github.io/struct/demos/basic-usage.gif", + "screenshot": "https://structio.netlify.app/demos/basic-usage.gif", "featureList": [ "YAML-Based Configuration", "Template Variables with Jinja2", @@ -53,11 +53,11 @@ "Cross-platform Support" ], "requirements": "Python 3.8+", - "installUrl": "https://httpdss.github.io/struct/docs/installation/", + "installUrl": "https://structio.netlify.app/docs/installation/", "supportingData": { "@type": "Dataset", "name": "STRUCT Documentation", "description": "Complete documentation and examples for STRUCT", - "url": "https://httpdss.github.io/struct/docs/" + "url": "https://structio.netlify.app/docs/" } } diff --git a/site/update-sitemap.sh b/site/update-sitemap.sh index 57ef12d..f167194 100755 --- a/site/update-sitemap.sh +++ b/site/update-sitemap.sh @@ -5,7 +5,7 @@ SITEMAP_FILE="sitemap.xml" DOCS_DIR="docs" -BASE_URL="https://httpdss.github.io/struct" +BASE_URL="https://structio.netlify.app" TODAY=$(date +%Y-%m-%d) echo "📄 Updating sitemap.xml with generated documentation pages..." From 35def26553ebe60c85cf844d2684ad25d0057d08 Mon Sep 17 00:00:00 2001 From: Kenneth Belitzky Date: Wed, 6 Aug 2025 13:06:54 +0000 Subject: [PATCH 2/3] feat: Migrate deployment configuration to netlify.toml and remove GitHub Actions workflow --- .github/workflows/deploy-site.yml | 67 ------------------------------- netlify.toml | 3 ++ 2 files changed, 3 insertions(+), 67 deletions(-) delete mode 100644 .github/workflows/deploy-site.yml create mode 100644 netlify.toml diff --git a/.github/workflows/deploy-site.yml b/.github/workflows/deploy-site.yml deleted file mode 100644 index cac9e26..0000000 --- a/.github/workflows/deploy-site.yml +++ /dev/null @@ -1,67 +0,0 @@ -name: deploy-site - -on: - push: - branches: ["main"] - paths: - - "site/**" - - "docs/**" - - "mkdocs.yml" - - "requirements.docs.txt" - - workflow_dispatch: - -permissions: - contents: read - pages: write - id-token: write - -concurrency: - group: "site" - cancel-in-progress: false - -jobs: - deploy: - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - with: - fetch-depth: 0 # Needed for git-revision-date-localized plugin - - - name: Setup Python - uses: actions/setup-python@v4 - with: - python-version: '3.x' - cache: 'pip' - - - name: Install MkDocs dependencies - run: | - pip install -r requirements.docs.txt - - - name: Build MkDocs documentation - run: | - mkdocs build - - - name: Upload artifact - uses: actions/upload-pages-artifact@v3 - with: - path: './site' - - - name: Deploy to Netlify - uses: nwtgck/actions-netlify@v3.0 - with: - publish-dir: './site' - production-branch: main - github-token: ${{ secrets.GITHUB_TOKEN }} - deploy-message: "Deploy from GitHub Actions" - enable-pull-request-comment: true - enable-commit-comment: true - overwrites-pull-request-comment: true - env: - NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} - NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }} - timeout-minutes: 1 diff --git a/netlify.toml b/netlify.toml new file mode 100644 index 0000000..6a48829 --- /dev/null +++ b/netlify.toml @@ -0,0 +1,3 @@ +[build] + publish = "site" + command = "mkdocs build" From 76721d0a21c9c23e2aabb27cbd8133ed9cead0c3 Mon Sep 17 00:00:00 2001 From: Kenneth Belitzky Date: Wed, 6 Aug 2025 13:09:15 +0000 Subject: [PATCH 3/3] fix: Update build command in netlify.toml to include dependencies installation --- netlify.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netlify.toml b/netlify.toml index 6a48829..78e14e1 100644 --- a/netlify.toml +++ b/netlify.toml @@ -1,3 +1,3 @@ [build] publish = "site" - command = "mkdocs build" + command = "pip install -r requirements.docs.txt && mkdocs build"