Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build docs preview and production builds in GitHub CI #628

Merged
merged 2 commits into from
Dec 23, 2021

Conversation

m-vdb
Copy link
Collaborator

@m-vdb m-vdb commented Dec 23, 2021

Relates to RasaHQ/rasa#10568

Proposed changes

  • 2 workflow changes:
    • On pull requests, build the docs, upload a preview to Netlify and add a comment to the PR with a link to the preview (only run the workflow if there were docs changes to avoid spamming devs). It uses the PR number for the deploy alias, so that it's deterministic.
    • On the documentation branch, build the docs and upload a production build to Netlify. Upon failure, send a message to Slack.
  • Secrets have been updated in the Repository settings

TODO

  • Manually disable deploys on Netlify
  • The changes should be automatically added to the documentation branch. If not (for whatever reason), investigate and manually port the changes there;
  • Document changes needed for Rasa X
  • Update the doc on documentation workflows in Notion
  • Prepare rollback plan

How to rollback

  • Comment the 2 workflow jobs introduced in this PR (not the whole workflow file). This needs to happen on the main branch, and should be automatically propagated to the documentation branch. If not, for some reason, do it manually.
  • Go to https://app.netlify.com/sites/rasahq-docsv2-rasa-sdk/deploys and click "Active Builds"

@m-vdb m-vdb force-pushed the build-docs-on-github-ci branch from 4f17550 to 1191106 Compare December 23, 2021 09:57
@github-actions
Copy link

🚀 A preview of the docs have been deployed at the following URL: https://628--rasahq-docsv2-rasa-sdk.netlify.app/docs/action-server

@m-vdb m-vdb requested a review from virtualroot December 23, 2021 10:02
@m-vdb m-vdb merged commit d52b3ec into main Dec 23, 2021
@m-vdb m-vdb deleted the build-docs-on-github-ci branch December 23, 2021 11:06
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.

2 participants