Merged
Conversation
validbeck
approved these changes
Aug 28, 2024
Co-authored-by: Beck <[email protected]>
Contributor
PR SummaryThis pull request introduces several enhancements to the
These changes aim to improve the deployment workflow by allowing branch-specific previews and cleanups, making it easier to manage documentation updates for different branches. Test Suggestions
|
Collaborator
Author
github-actions bot
added a commit
that referenced
this pull request
Aug 29, 2024
* Deploy PR previews to branch folders (#284) * Add PR preview deploy and delete to docs-demo site * Re-add missing Makefile updates * Remove --delete option from deploy-demo * Update site/Makefile Co-authored-by: Beck <[email protected]> * Tweak help wording --------- Co-authored-by: Beck <[email protected]> * Updated user management docs — Renaming roles (#285) * Edits to summaries of docs under Managing users * Added section for renaming roles * Quick tweak to Register models for user groups * Update site/guide/configuration/manage-permissions.qmd Co-authored-by: Nik Richers <[email protected]> * Update site/guide/configuration/manage-roles.qmd Co-authored-by: Nik Richers <[email protected]> * Quick tweak, comma unification --------- Co-authored-by: Nik Richers <[email protected]> --------- Co-authored-by: Nik Richers <[email protected]> Co-authored-by: Beck <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



Internal Notes for Reviewers
This PR adds the ability to deploy PR previews based on the working branch you are on. You can use this to deploy PR previews until we can automate the process via a GitHub workflow.
PR previews all go into a
s3://docs-ci-cd-demo/site/pr_previews/$(GIT_BRANCH)/folder to distinguish them from the rest of the docs-demo site which is otherwise largely untouched (see "One caveat").Run
maketo see the new options:Deploy a PR preview
Run
make deploy-demo-branch:The command line output gives you a link you can click to open the preview:
Delete
Run
make delete-demo-branch:This gives you the standard 404 and links then take you to the docs-demo site that is otherwise untouched.
Other ways of testing
You can also check that files get added or removed with the
aws s3command. E.g. check what happens withaws s3 ls s3://docs-ci-cd-demo/site/pr_previews/before and after you run the newmakecommands.One caveat
I had to remove the
--deleteoption from themake deploy-democommand as it otherwise deletes thepr_previews/subfolder. I think this an acceptable compromise as we might remove the regular docs-demo functionality at some point in the future. You mainly just need an index.html file in the root of the S3 bucket which we could generate in the future with all of the PR preview links.External Release Notes