[WIP] PR previews v2

.github/workflows/deploy.yml

@@ -17,16 +17,23 @@ concurrency:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout
         uses: actions/checkout@v4
         with:
           persist-credentials: false
+      - uses: awalsh128/cache-apt-pkgs-action@v1
+        with:
+          packages: calibre
       - name: Install and Build
         run: |
+          sudo apt install rename
           npm install
           npx honkit build
+          npx honkit epub
+          rename 's/^book/django-girls-tutorial/' book_*.epub
+          mv *.epub _book/
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
@@ -40,7 +47,7 @@ jobs:
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - name: Deploy to GitHub Pages
         id: deployment

.github/workflows/preview.yml

@@ -0,0 +1,109 @@
+name: Preview
+
+on:
+  workflow_run:
+    workflows:
+      - Build
+    types:
+      - completed
+
+jobs:
+  preview-failed:
+    if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion != 'success'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download metadata artifact
+        run: gh run download '${{ github.event.workflow_run.id }}' --name pr
+        env:
+          GH_TOKEN: ${{ github.token }}
+
+      - name: Read PR data
+        run: echo "PR_NUMBER=$(cat ./pr)" >> $GITHUB_ENV
+
+      - name: Comment on PR
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          number: ${{ env.PR_NUMBER }}
+          message: "The PR preview for ${{ github.event.workflow_run.head_sha }} could not be generated"
+
+  preview:
+    if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success'
+    runs-on: ubuntu-latest
+    steps:
+      # TODO: can this download from the existing pages or a cache?
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Build current pages
+        run: |
+          npm install
+          npx honkit build
+          mv _book current
+
+      - name: Download preview artifact
+        run: gh run download '${{ github.event.workflow_run.id }}' --name github-pages --dir preview
+        env:
+          GH_TOKEN: ${{ github.token }}
+
+      - name: Remove indeterminism
+        run: |
+          find current/ preview/ -type f -exec sed -i '/gitbook.page.hasChanged/d' {} +
+
+      - name: Create diff to current
+        run: |
+          diff -Nrwu --exclude search_index.json current/ preview/ > diff.patch || true
+          if [[ -s diff.patch ]] ; then
+            sudo apt-get update
+            sudo apt-get install -y diffstat python3-pygments
+
+            mv diff.patch preview/diff.patch
+            pygmentize -o preview/diff.html -l diff -f html -O full preview/diff.patch
+            diffstat -l -p1 preview/diff.patch > preview/diff.txt
+          fi
+
+      - name: Download metadata artifact
+        run: gh run download '${{ github.event.workflow_run.id }}' --name pr
+        env:
+          GH_TOKEN: ${{ github.token }}
+
+      - name: Read PR data
+        run: echo "PR_NUMBER=$(cat ./pr)" >> $GITHUB_ENV
+
+      - name: Set preview domain
+        run: echo "PREVIEW_DOMAIN=$(echo ${{ github.repository }} | tr / - )-${{ github.job }}-pr-${{ env.PR_NUMBER }}.surge.sh" >> $GITHUB_ENV
+
+      - name: Install surge
+        run: npm install surge
+
+      - name: Deploy to surge.sh
+        run: npx surge ./preview $PREVIEW_DOMAIN --token ${{ secrets.SURGE_TOKEN }}
+
+      - name: Generate summary
+        run: |
+          echo "The PR preview for ${{ github.event.workflow_run.head_sha }} is available at [${{ env.PREVIEW_DOMAIN }}](https://${{ env.PREVIEW_DOMAIN }})" >> pr.md
+          echo "" >> pr.md
+
+          if [[ -f preview/diff.txt ]] ; then
+            echo "The following output files are affected by this PR:" >> pr.md
+            sed -E "s#(.*)#- [\1](https://${{ env.PREVIEW_DOMAIN }}/\1)#" preview/diff.txt >> pr.md
+          else
+            echo "No diff compared to the current website" >> pr.md
+          fi
+
+          if [[ -s preview/diff.patch ]] ; then
+            echo "" >> pr.md
+            echo "[show diff](https://${{ env.PREVIEW_DOMAIN }}/diff.patch)" >> pr.md
+          fi
+
+          if [[ -f preview/diff.html ]] ; then
+            echo "" >> pr.md
+            echo "[show diff as HTML](https://${{ env.PREVIEW_DOMAIN }}/diff.html)" >> pr.md
+          fi
+
+      - name: Comment on PR
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          number: ${{ env.PR_NUMBER }}
+          path: pr.md

.github/workflows/test.yml

@@ -4,7 +4,7 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -15,3 +15,18 @@ jobs:
         run: |
           npm install
           npx honkit build
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: github-pages
+          path: _book/**
+
+      - name: Save PR metadata
+        run: |
+          echo ${{ github.event.number }} > ./pr
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: pr
+          path: ./pr

LANGS.md

@@ -1,20 +1 @@
 * [🇺🇸 English](en/)
-* [🇧🇬 Български (beta)](bg/)
-* [🇨🇿 Čeština (beta)](cs/)
-* [🇩🇪 Deutsch](de/)
-* [🇬🇷 Ελληνικά (beta)](el/)
-* [🇪🇸 Español (beta)](es/)
-* [🇮🇷 فارسی (beta)](fa/)
-* [🇫🇷 Français (beta)](fr/)
-* [🇭🇺 Magyar (beta)](hu/)
-* [🇦🇲 հայերեն (beta)](hy/)
-* [🇮🇹 Italiano (beta)](it/)
-* [🇯🇵 日本語](ja/)
-* [🇰🇵/🇰🇷 한국어 (beta)](ko/)
-* [🇵🇱 Polski](pl/)
-* [🇧🇷 Português-brasileiro](pt/)
-* [🇷🇺 Русский (beta)](ru/)
-* [🇸🇰 Slovenčina (beta)](sk/)
-* [🇹🇷 Türkçe (beta)](tr/)
-* [🇺🇦 Українська](uk/)
-* [🇨🇳 简体中文](zh/)

README.md

@@ -1,3 +1,5 @@
+[![Open in Codeanywhere](https://img.shields.io/badge/Open%20in-Codeanywhere-7f3f97)](https://app.codeanywhere.com/#https://github.com/DjangoGirls/tutorial)
+
 # Django Girls Tutorial
 
 ~ 🖥 Source Code 🖥 ~
@@ -44,7 +46,7 @@ For contributing to the tutorial the following is needed to get started:
 * a [GitHub account](https://github.com)
 * in the case of complex edits familiarity with [Git command line basics](https://help.github.com/articles/set-up-git) or familiarity with an app ([Windows](https://windows.github.com/), [Mac](https://mac.github.com/)) to push your edits made on your computer to GitHub.
 
-## Fork the repository
+## Fork the repository {#fork-the-repository}
 
 First fork the [DjangoGirls/tutorial](https://github.com/DjangoGirls/tutorial) repository to your personal GitHub account:
 
@@ -78,7 +80,7 @@ Markdown syntax is used to edit the individual pages of the tutorial.
 
 Save your changes and create a pull request as explained below.
 
-## New content and complex changes
+## New content and complex changes {#new-content-and-complex-changes}
 
 For adding new chapters, writing longer snippets of text or adding images, you need to get a copy of the tutorial to your local computer.
 
@@ -132,8 +134,28 @@ Example:
     To git@github.com:miohtama/tutorial.git
        b37ca59..fe36152  contributing -> contributing
 
-# Making a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
+# Restructuring the tutorial {#restructuring-the-tutorial}
+Restructuring the tutorial is a major change that takes time so we have created a separate branch for these changes. 
+
+To make contributions that address issues 
+[1777](https://github.com/DjangoGirls/tutorial/issues/1777) and [1792](https://github.com/DjangoGirls/tutorial/issues/1792), 
+[fork](#fork-the-repository) the repository your repository.
+
+Next you need to follow instructions for [cloning and setting up locally given in the section above](#new-content-and-complex-changes).
+
+Please make use of ["semantic linefeeds"](https://rhodesmill.org/brandon/2012/one-sentence-per-line/) a.k.a. 
+["semantic line breaks"](https://sembr.org/) for all paragraphs. 
+Though most of the Django Girls tutorial wasn't originally written that way, placing source line breaks at semantically meaningful spots in the text (and especially between sentences) facilitates both, commenting on individual statements or thoughts in the text as part of the review process, as well as future editing and diff-ing.
+
+As we restructure the tutorial, this would be a great change to introduce to the tutorial so please make sure the chapter you work on follow this pattern.
+
+All pull requests for changes aimed at restructuring the tutorial which address the issues 
+[1777](https://github.com/DjangoGirls/tutorial/issues/1777) and [1792](https://github.com/DjangoGirls/tutorial/issues/1792) 
+should be made to the `restructure-tutorial`.
+
+All other steps for creating a pull request are the same as those outlined in the section on [making a pull request below](#making-a-pull-request), just make sure you make the pull request against the `restructure-tutorial` branch.
 
+# Making a pull request {#making-a-pull-request}
 After you have finished your changes you need to [create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)  on GitHub. DjangoGirls will get notified about the pull request, review your changes, suggest any corrections if needed and then *pull* your changes to the master version.
 
 In your own repository on GitHub press do *Compare & pull request*