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

docs: deploy gh pages #541

Merged
merged 7 commits into from
Feb 5, 2021
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
178 changes: 0 additions & 178 deletions .circleci/config.yml

This file was deleted.

31 changes: 31 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Documentation
# This job builds and deploys documenation to github pages.
# It runs on every push to master.
on:
push:
branches:
- master

jobs:
build-and-deploy:
runs-on: ubuntu-latest
container:
image: tendermintdev/docker-website-deployment
steps:
- name: Checkout 🛎️
uses: actions/[email protected]
with:
persist-credentials: false
fetch-depth: 0

- name: Install and Build 🔧
run: |
apk add rsync
make build-docs LEDGER_ENABLED=false

- name: Deploy 🚀
uses: JamesIves/[email protected]
Copy link
Contributor

Choose a reason for hiding this comment

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

What I meant was to update the action with https://github.com/marketplace/actions/netlify-deploy And change the branch name to netlify-docs

@marbar3778

Copy link
Member Author

Choose a reason for hiding this comment

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

I understand, but this migrates from github-pages to nelify. Cosmos-sdk and Tendermint are on github-pages, I'm not sure why gaia should be different?

I understand that something may be easier but having a unified system across all repos is better IMO.

Choose a reason for hiding this comment

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

I agree with @marbar3778 in having a unified system, but also understand @lovincyrus about deploy previews. Fortunately, we can have both worlds, right? We point DNS at github pages and still link Netlify to the repo for deploy previews. Anyway, I think this PR should be merged.

Copy link
Contributor

Choose a reason for hiding this comment

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

Sure, let's do that. For any new changes about Netlify, we can do that another time.

with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages
FOLDER: ~/output
24 changes: 24 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,27 @@ jobs:
file: ./coverage.txt # optional
fail_ci_if_error: true
if: "env.GIT_DIFF != ''"

liveness-test:
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- uses: actions/checkout@v2
- uses: actions/[email protected]
with:
go-version: 1.15
- uses: technote-space/get-diff-action@v4
id: git_diff
with:
PATTERNS: |
**/**.go
go.mod
go.sum
- name: start localnet
run: |
make clean build-simd-linux localnet-start
if: env.GIT_DIFF
- name: test liveness
run: |
./contrib/localnet_liveness.sh 100 5 50 localhost
if: env.GIT_DIFF
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -134,11 +134,12 @@ distclean: clean
build-docs:
@cd docs && \
while read p; do \
(git checkout $${p} && npm install && VUEPRESS_BASE="/$${p}/" npm run build) ; \
(git checkout $${p} && npm install && VUEPRESS_BASE="/gaia/$${p}/" npm run build) ; \
tac0turtle marked this conversation as resolved.
Show resolved Hide resolved
mkdir -p ~/output/$${p} ; \
cp -r .vuepress/dist/* ~/output/$${p}/ ; \
cp ~/output/$${p}/index.html ~/output ; \
done < versions ;
.PHONY: build-docs

sync-docs:
cd ~/output && \
Expand Down