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

Add PR Builds and Previews #48

Open
bmorelli25 opened this issue Nov 11, 2024 · 1 comment
Open

Add PR Builds and Previews #48

bmorelli25 opened this issue Nov 11, 2024 · 1 comment
Labels
automation packaging, ci/cd.

Comments

@bmorelli25
Copy link
Member

Summary

Documentation PRs should need CI that validates the content before it can be merged.

When a PR is opened or Synchronized, our Asciidoc PR builds do the following.:

  • Build the PR on BuildKite
  • Check all internal links
  • Push the built HTML files to the elastic/built-docs directory
  • Publish built HTML files so the entire content set is viewable in the context of the PR
  • Show a diff of the built HTML files for easy validation

Requirements

To be scoped

@bmorelli25
Copy link
Member Author

  • Can potentially reuse vercel publish action in the meantime
  • Can potentially spin up an S3 bucket, create an S3 website and have the action post to S3
    • Use object retention & know when PRs are merged
    • Don't have to handle credentials, auth handled by gh repo access to aws

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation packaging, ci/cd.
Projects
None yet
Development

No branches or pull requests

2 participants