ongdisheng opened a new pull request, #667:
URL: https://github.com/apache/fesod/pull/667

   <!--
   Thanks very much for contributing to Apache Fesod (Incubating)! Please make 
sure that your code changes
   are covered with tests. And in case of new features or big changes
   remember to adjust the documentation.
   
   Feel free to ping committers for the review!
   
   In case of an existing issue, reference it using one of the following:
   
   Closed: #ISSUE
   Related: #ISSUE
   
   -->
   Closed: #638 
   
   ## Purpose of the pull request
   
   <!-- Describe the purpose of this pull request. For example: Closed: 
#ISSUE-->
   This PR implements Netlify preview deployments for documentation changes 
using GitHub Actions. It addresses issue #638 by enabling automatic preview 
site generation when contributors submit pull requests that modify 
documentation files. This allows reviewers to see the rendered documentation 
before merging changes to the main branch.
   
   ## What's changed?
   
   <!--- Describe the change below, including rationale and design decisions -->
   This PR added a new GitHub Actions workflow file `preview-docs.yml` that 
automatically deploys documentation previews to Netlify when pull requests 
modify files in the `website` directory. The workflow uses the 
[actions-netlify](https://github.com/marketplace/actions/netlify-actions) to 
handle the deployment and automatically posts the preview URL as a comment on 
the pull request. It only triggers for pull requests that contain changes to 
the documentation, ensuring that code-only pull requests do not consume build 
resources unnecessarily. This implementation requires two repository secrets to 
be configured in the repository settings:
   
   - `NETLIFY_AUTH_TOKEN`: A personal access token from Netlify for 
authentication
   - `NETLIFY_SITE_ID`: The API ID of the Netlify site where previews will be 
deployed
   
   _Note: A working demonstration of this workflow can be seen in this test [PR 
](https://github.com/ongdisheng/fesod/pull/6) on my fork, where the GitHub 
Actions bot successfully posted the preview URL._
   
   ## Checklist
   
   - [ ] I have read the [Contributor 
Guide](https://fesod.apache.org/community/contribution/).
   - [ ] I have written the necessary doc or comment.
   - [ ] I have added the necessary unit tests and all cases have passed.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to