Skip to content

Commit

Permalink
ci: publish README on every build
Browse files Browse the repository at this point in the history
  • Loading branch information
matfax committed Mar 5, 2019
1 parent 35382ee commit c992527
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
2 changes: 2 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ jobs:
include:
- stage: "Integration Tests"
script: yarn test
- stage: "Publish README"
script: ./siteleaf-updater --site 5c7e78ecaf67d949a5972c82
- stage: deploy
script: yarn publish
if: tag IS present
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,19 @@ Hosting on the master branch has the advantage that files can be shared with the
However, pages usually stand alone without a dependency to or from the project files.
Hence, there might be numerous commits that cause an avoidable overhead to merges, CI, and pulls.

### 2. Host it on a separate branch
### 2. Host it on a dedicated branch

Hosting the pages on a separate branch (e.g., `gh-pages`) has the benefit that this beforementioned overhead is avoided.
Hosting the pages on a dedicated branch (e.g., `gh-pages`) has the benefit that this beforementioned overhead is avoided.
Separate concerns are rooted in separate trees, just as it is supposed to be.
However, normally, developers only want to publish their README with a few additions.
There is no integrated way or known method in GitHub to sync the README file without hooks or different workarounds.
That circumstance impairs common maintenance and automation requirements.

## Solution

1. Use [Siteleaf](https://www.siteleaf.com/), and publish to GitHub
2. Setup your CI to use `siteleaf-updater` for automated doc updates
1. Use [Siteleaf](https://www.siteleaf.com/), and publish or sync to a dedicated branch on GitHub.
2. Create a page and assign it a path (by default, `index`).
3. Setup your CI to use `siteleaf-updater` for automated doc updates.

## Parameters

Expand Down

0 comments on commit c992527

Please sign in to comment.