This is an automated email from the ASF dual-hosted git repository.
jamesbognar pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/juneau.git
The following commit(s) were added to refs/heads/master by this push:
new 699a69821 New GitHub workflow to set up pages
699a69821 is described below
commit 699a69821211c2555105b07e061e73106d497719
Author: James Bognar <[email protected]>
AuthorDate: Sat Sep 13 08:17:59 2025 -0400
New GitHub workflow to set up pages
---
.github/README-PAGES.md | 29 +++++++++++++++++++++
.github/workflows/pages.yml | 63 +++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 92 insertions(+)
diff --git a/.github/README-PAGES.md b/.github/README-PAGES.md
index 1bd5467ce..b5782b2f5 100644
--- a/.github/README-PAGES.md
+++ b/.github/README-PAGES.md
@@ -47,12 +47,41 @@ Once deployed, the comprehensive site will be available at:
## Manual Setup Required
+### GitHub Pages Setup
After pushing this workflow, enable GitHub Pages in your repository:
1. Go to **Settings** → **Pages**
2. Under **Source**, select **GitHub Actions**
3. The site will be available at: `https://<username>.github.io/juneau/`
+### Email Notifications Setup
+To receive email notifications when deployments complete or fail, configure
these GitHub repository secrets:
+
+1. Go to **Settings** → **Secrets and variables** → **Actions**
+2. Add the following **Repository secrets**:
+
+| Secret Name | Value | Description |
+|-------------|-------|-------------|
+| `MAIL_USERNAME` | `[email protected]` | Gmail address to send from |
+| `MAIL_PASSWORD` | `your-app-password` | Gmail App Password (not regular
password) |
+| `NOTIFICATION_EMAIL` | `[email protected]` | Email address to
receive notifications |
+
+### Gmail App Password Setup
+For security, use Gmail App Passwords instead of your regular password:
+
+1. Go to [Google Account settings](https://myaccount.google.com/)
+2. Navigate to **Security** → **2-Step Verification** (enable if not already)
+3. Go to **Security** → **App passwords**
+4. Generate a new app password for "GitHub Actions"
+5. Use this 16-character password as `MAIL_PASSWORD`
+
+### Alternative Email Providers
+To use other email providers, update the workflow SMTP settings:
+
+- **Outlook/Hotmail**: `smtp.live.com:587`
+- **Yahoo**: `smtp.mail.yahoo.com:587`
+- **Custom SMTP**: Update `server_address` and `server_port` in the workflow
+
## Local Development
To generate the complete project site locally:
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
index 9e6809bb1..aba89c922 100644
--- a/.github/workflows/pages.yml
+++ b/.github/workflows/pages.yml
@@ -99,3 +99,66 @@ jobs:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
+
+ - name: Send success notification
+ if: success()
+ uses: dawidd6/action-send-mail@v3
+ with:
+ server_address: smtp.gmail.com
+ server_port: 587
+ username: ${{ secrets.MAIL_USERNAME }}
+ password: ${{ secrets.MAIL_PASSWORD }}
+ subject: "✅ Juneau GitHub Pages Deployed Successfully"
+ to: ${{ secrets.NOTIFICATION_EMAIL }}
+ from: ${{ secrets.MAIL_USERNAME }}
+ body: |
+ 🎉 **Juneau Documentation Successfully Deployed!**
+
+ **Project:** Apache Juneau
+ **Branch:** ${{ github.ref_name }}
+ **Commit:** ${{ github.sha }}
+ **Author:** ${{ github.actor }}
+ **Workflow:** ${{ github.workflow }}
+ **Run:** ${{ github.run_number }}
+
+ **📚 Site URL:** ${{ steps.deployment.outputs.page_url }}
+
+ **📊 Build Details:**
+ - Repository: ${{ github.repository }}
+ - Triggered by: ${{ github.event_name }}
+ - Run ID: ${{ github.run_id }}
+
+ The complete project site including API documentation, test
reports, and project information is now live!
+
+ - name: Send failure notification
+ if: failure()
+ uses: dawidd6/action-send-mail@v3
+ with:
+ server_address: smtp.gmail.com
+ server_port: 587
+ username: ${{ secrets.MAIL_USERNAME }}
+ password: ${{ secrets.MAIL_PASSWORD }}
+ subject: "❌ Juneau GitHub Pages Deployment Failed"
+ to: ${{ secrets.NOTIFICATION_EMAIL }}
+ from: ${{ secrets.MAIL_USERNAME }}
+ body: |
+ 🚨 **Juneau Documentation Deployment Failed!**
+
+ **Project:** Apache Juneau
+ **Branch:** ${{ github.ref_name }}
+ **Commit:** ${{ github.sha }}
+ **Author:** ${{ github.actor }}
+ **Workflow:** ${{ github.workflow }}
+ **Run:** ${{ github.run_number }}
+
+ **🔍 Troubleshooting:**
+ - Check the workflow logs: https://github.com/${{
github.repository }}/actions/runs/${{ github.run_id }}
+ - Verify the build process and dependencies
+ - Check for any Maven or site generation errors
+
+ **📊 Build Details:**
+ - Repository: ${{ github.repository }}
+ - Triggered by: ${{ github.event_name }}
+ - Run ID: ${{ github.run_id }}
+
+ Please check the logs and retry the deployment.
