Skip to content

Commit 34ec98f

Browse files
MarkusMarkus
authored andcommitted
Added Clarification for new automagic website update
1 parent 10de139 commit 34ec98f

1 file changed

Lines changed: 6 additions & 13 deletions

File tree

README.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,11 @@ This is the branch for the pages.
44

55
Link for Website: http://iluwatar.github.io/java-design-patterns/
66

7-
## How to update the website reference
7+
## The website reference
88

9-
Due to the fact that we use submodules, the website doesn't automatically
10-
update with the changes in the master branch. And for now this update process
11-
is manual, here is how you do it:
9+
Due to the fact that we use git submodules, the website normally
10+
wouldn't automatically update with the changes in the master branch.
1211

13-
1. checkout the latest version of the gh-pages branch
14-
2. open a Git Bash at root level of the repo (ls should show you the index.html file)
15-
3. execute the following command to initialize the submodules `git submodule update --init --recursive`
16-
4. execute the following command to update the submodule `git submodule update --remote`
17-
5. Check the cmd output line "Submodule path 'pattern': checked out 'COMMIT_HASH'" and validate that the correct COMMIT_HASH is used
18-
6. Check if something changed with `git diff`. It should show the folder 'patterns' changed.
19-
7. Execute `git add .`
20-
8. Commit and push the change
21-
9. The website is automatically updated using Jekyll (see [GitHub Pages Basics](https://help.github.com/categories/github-pages-basics) and [Using Jekyll with Pages](https://help.github.com/articles/using-jekyll-with-pages/))
12+
To enable the automatic update of the submodule reference we use
13+
the [update-ghpages.sh](https://github.com/iluwatar/java-design-patterns/blob/master/update-ghpages.sh)
14+
script in the master branch together with Travis-CI.

0 commit comments

Comments
 (0)