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

Issue548 gh pages in master #616

Merged
merged 4 commits into from
Dec 15, 2020

Conversation

jsmailes
Copy link
Contributor

@jsmailes jsmailes commented Oct 1, 2020

What does this implement/fix? Explain your changes.

Changes the process of building and deploying documentation so make build-gh-pages is no longer necessary.

The contents of the gh-pages branch has been moved to the docs folder in the master branch.

On push to the master branch (or when a pull request is merged with master), a GitHub Action is triggered which pushes any changes to the docs folder to the gh-pages branch.

This does not change behaviour of the site and does not require any configuration changes, but it improves the repository's usability by getting rid of the need to keep track of two long-live branches.

Does this close any currently open issues?

This closes issues #484 and #548 by unifying the gh-pages and master branches and automating updates of the site based on changes to the master branch.

Any relevant logs, error output, etc?

(If it’s long, please paste to https://ghostbin.com/ and insert the link here.)

Any other comments?

It may be possible to make this change using Travis instead of GitHub Actions if desired.

I am more familiar with GitHub Actions so that's what I've used here, but I imagine it would be possible to get the same results with a Travis configuration file.

@joshrabinowitz
Copy link
Collaborator

@jsmailes thank you for this PR! I really appreciate it.

Can you please give detailed instructions how I should test this branch?

I'm sort of drawing a blank -- I don't typically use git hooks or github actions -- but maybe I should!

Copy link
Owner

@sobolevn sobolevn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! 👍

steps:
- uses: actions/checkout@v2
with:
submodules: recursive
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't have any submodules. So, this can be skipped (I guess).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sobolevn did you test this branch?

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not yet.

@joshrabinowitz
Copy link
Collaborator

Update for @jsmailes - I'll look at this in depth after we get the next release out.

@joshrabinowitz
Copy link
Collaborator

OK, I've looked this over.

The ideal solution, I think, would be to stop using the gh-pages branch all together, and instead put all the files for git-secret.io in a directory somewhere like .gh-pages/, in the master branch.

Is this doable?

@sobolevn
Copy link
Owner

sobolevn commented Nov 19, 2020

Yes, github can build docs from docs/ folder from the master branch now.

@joshrabinowitz
Copy link
Collaborator

joshrabinowitz commented Nov 20, 2020

I think we should do what @sobolevn describes above, and use the (magical) /docs folder in master instead of the magical gh-pages branch

@jsmailes, would you be amenable to re-doing this PR using just the /docs folder and without depending on the gh-pages branch?

@sobolevn sobolevn merged commit eafd3fc into sobolevn:master Dec 15, 2020
@jsmailes jsmailes deleted the issue548-gh-pages-in-master branch December 18, 2020 11:36
@sobolevn sobolevn mentioned this pull request May 6, 2021
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.

None yet

3 participants