You are viewing a plain text version of this content. The canonical link for it is here.

Posted to jdo-dev@db.apache.org by GitBox <gi...@apache.org> on 2021/01/03 17:37:53 UTC

[GitHub] [db-jdo-site] tobous opened a new pull request #13: Move site to separate branch

tobous opened a new pull request #13:
URL: https://github.com/apache/db-jdo-site/pull/13

**NOTE** *This PR also contains the commit of PR #12. As I don't have direct write access to the repository (i.e. can't create branches), don't have any way of creating correctly stacked PRs (i.e. PRs depending on each other). So the first commit in this PR can just be ignored.*

Adjusts the site deployment job to instead deploy the site to a separate branch. This has the advantage that the build artifacts no longer have to be kept as part of the master branch. Instead, they are pushed to the orphan branch `site`. (The branch name is arbitrary. I can adjust it if you have a better suggestion.)

The separate site branch only contains the site build artifacts and the site configuration files (`.asf.yaml` and `.htaccess`). All these resources are located directly in the root directory. The site branch will be completely overwritten when a new build is deployed, so only the latest build artifacts will be stored.

As I am not that familiar with the site deployment infrastructure on the Apache side (especially the correct `.asf.yaml` and `.htaccess` configuration), it would be best to have somebody who is familiar with the topic have a look at it before merging. My changes are based on [this wiki entry](https://cwiki.apache.org/confluence/display/INFRA/git+-+.asf.yaml+features).

### Reviewing this PR

This PR subsequently also removes the currently committed site build artifacts as they will no longer be needed. As these changes are largely irrelevant for reviewing the PR, I would suggest only looking at the first commit ('`Move site build artifacts to separate 'site' branch`').

### Things to do after (or when) merging this PR

As this PR changes the site deployment mechanisms, you will have to adjust the GitHub configuration to also deploy the site as GitHub pages. You can simply change the branch to deploy to the site branch (currently `site`). The resources are located in the root directory, so no further configuration should be necessary.

Additionally, as the site deployment is now dependent on a separate branch, I would suggest setting up branch protection for the site branch to avoid it being accidentally deleted. This can be done in the repo settings in the "Branches" category. As the deploy action force pushes the branch, allowing force pushes will be necessary (second to last option "Allow force pushes").

### Commits

<details><summary>Move site build artifacts to separate 'site' branch</summary>

Adjusts the deploy action to create a new orphan branch 'site'
containing only the site build artifacts and site configuration in the
root directory. This branch is then force-pushed to the repo, replacing
the previous site build.

This approach avoids having to include the site artifacts in the master
branch.

Moves '.asf.yaml' to 'asf.yaml.template' as it is now no longer needed
on the master branch. It is renamed to '.asf.yaml' as part of the deploy
action.

Adjusts '.asf.yaml.template' to match the new setup. Changes the branch
id to 'site'.

</details>

<details><summary>Remove 'docs/' and 'content'</summary>

Removes the 'docs/' directory containing the site build artifacts. They
are no longer necessary on the master branch as they will now be
deployed to the separate 'site' branch.

Removes the 'content' symlink pointing to 'docs/'.

</details>

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org