Skip to content

Conversation

@f-hollow
Copy link
Collaborator

@f-hollow f-hollow commented Dec 18, 2025

Description

Note

Previews will not work in this PR, because preview workflows have been updated here.

This PR improves the website deployment strategy for PR previews on GitHub:

  • Old: The workflow pr-build-preview used to build the website on the fork side. Then it triggered the workflow prw-deploy-preview on the upstream repo side. The build files were passed via artifacts which took more time. aws s3 was used for deployment with custom logic to prevent re-uploading unchanged files (ci: optimize file syncing with s3 #381).
  • New: The workflow pr-trigger-preview collects the PR details on the fork side. Then it triggered the workflow prw-deploy-preview on the upstream repo side. The website build and deploy is done in the same workflow. File syncing is managed by Hugo much more efficiently.

Key improvements:

  • Now uploading all files to our s3 bucket takes around 2 minutes. With aws-cli it took around 4 minutes.
  • When a PR is updated, file syncing happens in under 1 minute.
  • Added a fix to correct the article links on the main page. If and once the issue with the article shortcode and base URL having subfolders is fixed, we will revert this commit.

Follow-up actions

Once we make sure that this workflow works file, we will reuse it for the production environment.

Related

Testing

Thorough testing was done in PR #22


Checklist

Before submitting a Pull Request, please ensure the following:

  • 🚨 This PR does not introduce breaking changes.
  • All CI checks (GH Actions) pass.
  • Documentation is updated as needed.
  • Tests are updated or added as necessary.
  • Code is well-commented, especially in complex areas.
  • Git history is clean — commits are squashed to the minimum necessary.

@f-hollow
Copy link
Collaborator Author

@pedrominatel @FBEZ PTAL

@FBEZ
Copy link
Collaborator

FBEZ commented Dec 18, 2025

LGTM

@f-hollow f-hollow merged commit ddead3a into espressif:main Dec 22, 2025
3 checks passed
@f-hollow f-hollow deleted the ci/deploy_website_using_hugo_deploy branch December 22, 2025 07:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants