Added preview functionality to the podman repo - #650
Open
antedotee wants to merge 1 commit into
Open
Conversation
Signed-off-by: antedotee <soniyadav2051982@gmail.com>
Contributor
Author
|
In case of any doubts or clarifications needed, please let me know. |
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.
Concisely describe the change
I have added the preview functionality in this repo. Now, if anyone makes any changes to the docs, a preview link will automatically be appended to the PR description with the associated changes contributor has made to the PR. It will help other people, and specifically, maintainers, to preview the changes directly, without having to run them locally.
Below is an example of how it looks when I tried to make a change and raise a PR:


Here is the deployed link url -> https://antedotee.github.io/podman.io/pr-preview/pr-2/
I have changed the title in the hero section to see if it works, and it worked.
Here is the PR in case you want to look at it -> antedotee#2
Here is the PR description, after running the workflow to generate preview, automatically a preview link gets added to the PR description:
In case you think the changes are goof enough to merge, you will have to edit some additional settings in the repository in order to make it work.

In case workflow permissions are not already set to read and write, do it:
Additionally, you will have to go to pages section in settings and set the branch to gh-pages:

After the following, for each PR, the preview link will be in the form of https://podman.io/https:/podman.io/pr-preview/pr-/
Fixes #552
Checklist
Ensure you have completed the following checklist for your pull request to be reviewed:
commits. (
git commit -s). (If needed, usegit commit -s --amend). The author email must matchthe sign-off email address. See CONTRIBUTING.md
for more information.
Fixes: #00000in commit message (if applicable)