Publishing Workflow Upgrade - Phase 1: HTML Archive to Release Assets

[mmcky]

Overview

This issue tracks the implementation of Phase 1 publishing workflow upgrades across QuantEcon lecture repositories. The upgrade adds HTML archive backups to GitHub release assets.

Changes Implemented

The following steps have been added to the publish.yml workflow in each repository:

1. Create HTML archive - Compresses _build/html/ into a .tar.gz archive after the HTML build
2. Generate checksum - Creates SHA256 hash for integrity verification (html-checksum.txt)
3. Create manifest - Generates metadata file with build information (html-manifest.json)
4. Upload to release - Attaches all three files to the GitHub release using softprops/action-gh-release@v1

Release Assets Created

Each publish-* tag will now include:

• 📦 {repo-name}-html-{tag}.tar.gz - Full HTML site archive (~200-300 MB)
• 🔐 html-checksum.txt - SHA256 verification file
• 📋 html-manifest.json - Build metadata (tag, commit, timestamp, size, file count)

Implementation Status

✅ Pull Requests Created

Repository	PR	Status
lecture-python.myst	#662	✅ Merged (Reference)
lecture-python-programming.myst	#422	✅ Merged
lecture-python-advanced.myst	#289	✅ Merged
lecture-python-intro	#659	✅ Merged
lecture-jax	#239	✅ Merged
lecture-intro.zh-cn	#191	🔄 Open
lecture-python-programming.fa	#15	🔄 Open

🔄 Pending Repositories

Repository	Status	Notes
lecture-datascience.myst	⏳ Pending	Not yet implemented
lecture-julia.myst	⏳ Pending	Not yet implemented
lecture-python.zh-cn	⏳ Pending	Not yet implemented

Key Features

• ✅ Does not modify _build/html/ directory (gh-pages deployment unaffected)
• ✅ Preserves existing release notes (no body override)
• ✅ Automatic tag detection from workflow context
• ✅ Creates safety net before Phase 2 (gh-pages history cleanup)

Testing Plan

After merging each PR, test with a publish-test-* tag to verify:

1. Workflow completes successfully
2. Three HTML assets are attached to release
3. Archive can be downloaded and extracted
4. Checksum verification works: sha256sum -c html-checksum.txt

Related

• Original Issue: lecture-python.myst#661
• Reference PR: lecture-python.myst#662
• Phase 2: gh-pages history cleanup (to be implemented after Phase 1 is tested and verified)

Next Steps

• Review and merge open PRs
• Test with publish-test-* tags
• Monitor first production releases
• Implement Phase 1 for remaining repositories
• Plan Phase 2 implementation (gh-pages orphan branch conversion)

[mmcky]

Phase 1 Implementation Complete

All pending repositories have now been updated with PRs:

New PRs Created

Repository	PR	Status
lecture-datascience.myst	#275	🔄 Open
lecture-julia.myst	#372	🔄 Open
lecture-python.zh-cn	#96	🔄 Open

Summary

Phase 1 is now complete for all lecture repositories. Each PR adds:

1. HTML archive creation - Compresses _build/html/ into {repo}-html-{tag}.tar.gz
2. SHA256 checksum - For integrity verification
3. Build manifest - JSON metadata with tag, commit, timestamp, size, and file count
4. Release upload - Attaches all files to GitHub release via softprops/action-gh-release@v2

Next Steps

1. Review and merge the open PRs
2. Test with publish-test-* tags
3. Monitor first production releases
4. Plan Phase 2 (gh-pages orphan branch conversion)

[mmcky]

Status Update

Active Lecture Repositories - Phase 1 Complete

All active lecture repositories now have Phase 1 PRs created or merged:

Repository	PR	Status
lecture-python.myst	#662	✅ Merged (Reference)
lecture-python-programming.myst	#422	✅ Merged
lecture-python-advanced.myst	#289	✅ Merged
lecture-python-intro	#659	✅ Merged
lecture-jax	#239	✅ Merged
lecture-intro.zh-cn	#191	�� Open
lecture-python-programming.fa	#15	🔄 Open
lecture-datascience.myst	#275	🔄 Open
lecture-julia.myst	#372	🔄 Open
lecture-python.zh-cn	#96	🔄 Open

Legacy Repositories - Skipped

The following lecture repositories are scheduled for archival and will not receive the Phase 1 upgrade:

• lecture-dle
• lecture-dps
• lecture-dynamics
• lecture-econometrics-machine-learning
• lecture-eqm
• lecture-stats
• lecture-tools-techniques

Next Steps

1. Review and merge the 5 open PRs
2. Test with publish-test-* tags
3. Monitor first production releases
4. Plan Phase 2 (gh-pages orphan branch conversion)

[mmcky]

Correction - Updated Status

Active Lecture Repositories - Phase 1 Status

Repository	PR	Status
lecture-python.myst	#662	✅ Merged (Reference)
lecture-python-programming.myst	#422	✅ Merged
lecture-python-advanced.myst	#289	✅ Merged
lecture-python-intro	#659	✅ Merged
lecture-jax	#239	✅ Merged
lecture-intro.zh-cn	#191	✅ Merged
lecture-python-programming.fa	#15	✅ Merged
lecture-datascience.myst	#275	🔄 Open
lecture-julia.myst	#372	🔄 Open
lecture-python.zh-cn	#96	🔄 Open

Legacy Repositories - Skipped

The following lecture repositories are scheduled for archival and will not receive the Phase 1 upgrade:

• lecture-dle
• lecture-dps
• lecture-dynamics
• lecture-econometrics-machine-learning
• lecture-eqm
• lecture-stats
• lecture-tools-techniques

Next Steps

1. Review and merge the 3 open PRs
2. Test with publish-test-* tags
3. Monitor first production releases
4. Plan Phase 2 (gh-pages orphan branch conversion)

[mmcky]

Final Status Update

Active Lecture Repositories - Phase 1 Complete ✅

All active lecture repositories have Phase 1 merged:

Repository	PR	Status
lecture-python.myst	#662	✅ Merged (Reference)
lecture-python-programming.myst	#422	✅ Merged
lecture-python-advanced.myst	#289	✅ Merged
lecture-python-intro	#659	✅ Merged
lecture-jax	#239	✅ Merged
lecture-intro.zh-cn	#191	✅ Merged
lecture-python-programming.fa	#15	✅ Merged
lecture-datascience.myst	#275	🔄 Open
lecture-julia.myst	#372	✅ Merged
lecture-python.zh-cn	#96	✅ Merged

Legacy Repositories - Skipped

The following lecture repositories are scheduled for archival and will not receive the Phase 1 upgrade:

• lecture-dle
• lecture-dps
• lecture-dynamics
• lecture-econometrics-machine-learning
• lecture-eqm
• lecture-stats
• lecture-tools-techniques

Next Steps

1. Review and merge the remaining open PR (lecture-datascience.myst)
2. Test with publish-test-* tags
3. Monitor first production releases
4. Plan Phase 2 (gh-pages orphan branch conversion)

[mmcky]

All repos are setup, datascience is just waiting on some execution fixes but will be merged after that is complete.

Closing Phase 1 is now complete.