Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewkroh committed Feb 25, 2021
1 parent 64ba6a4 commit 1c7e225
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
6 changes: 5 additions & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,9 @@ jobs:
run: VERSION=${{ github.sha }} make build

- name: publish gh-pages
run: VERSION=${{ github.sha }} make gh-pages
if: github.ref == 'refs/heads/master' && github.event_name == 'push'
run: |
git config user.name "Github Actions"
git config user.email "[email protected]"
git remote set-url origin https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
VERSION=${{ github.sha }} make gh-pages
9 changes: 8 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
== Beats Playground
# Beats Playground

Demo: https://andrewkroh.github.io/beats-playground/

Expand All @@ -21,3 +21,10 @@ for connections at http://localhost:8084/.

Run `make` and it will produce the `beats-playground` self-contained binary.
Building have several requirements like Go and `yarn`.

## Releasing

Pushes to master automatically update the demo page host by Github Pages. The
commit ID can be verified by looking at the browser's console.

Git tags automatically trigger uploads of binaries to the Github release page.
2 changes: 1 addition & 1 deletion ui/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"test": "react-scripts test",
"eject": "react-scripts eject",
"predeploy": "PUBLIC_URL=https://andrewkroh.github.io/beats-playground/ yarn build",
"deploy": "gh-pages -d build --repo https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git --user 'Gitub Actions <[email protected]>'"
"deploy": "gh-pages -d build"
},
"eslintConfig": {
"extends": "react-app"
Expand Down

0 comments on commit 1c7e225

Please sign in to comment.