Added Netlify Github Action and one readme change. (#25)

* Added Netlify Github Action and one readme change.

Signed-off-by: Jonsy13 <vedant.shrotria@chaosnative.com>
This commit is contained in:
VEDANT SHROTRIA 2021-06-09 10:36:52 +05:30 committed by GitHub
parent 67885662e4
commit e3bc991fb8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 47 additions and 29 deletions

View File

@ -1,25 +1,22 @@
name: LitmusDocs-CI name: LitmusDocs-CI
on: on:
pull_request: pull_request:
types: [ opened, synchronize, reopened ] types: [opened, synchronize, reopened]
paths: paths:
- '.github/workflows/dockerbuild.yml' - "website/**"
- '.github/workflows/Pull_Request.yml'
- 'website/**'
jobs: jobs:
embedmdCheck_and_linksVerification: embedmdCheck_and_linksVerification:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
with: with:
ref: ${{steps.getcommit.outputs.sha}} ref: ${{steps.getcommit.outputs.sha}}
- uses: actions/setup-go@v2 - uses: actions/setup-go@v2
with: with:
stable: 'false' stable: "false"
go-version: '1.14.0' go-version: "1.14.0"
- name: Links Verification - name: Links Verification
run: | run: |
@ -32,10 +29,10 @@ jobs:
go get github.com/campoy/embedmd go get github.com/campoy/embedmd
cd website/docs cd website/docs
embedmd -w $(find *.md) embedmd -w $(find *.md)
continue-on-error: true continue-on-error: true
- name: embedmd check - name: embedmd check
run: | run: |
export TERM=xterm-256color export TERM=xterm-256color
count=$(git status -s| wc -l) count=$(git status -s| wc -l)
if [ "$count" -ne "0" ] if [ "$count" -ne "0" ]
@ -53,7 +50,7 @@ jobs:
tput setaf 2; echo "Nothing to embed" tput setaf 2; echo "Nothing to embed"
fi fi
shell: sh shell: sh
ci: ci:
runs-on: ubuntu-18.04 runs-on: ubuntu-18.04
steps: steps:
@ -65,11 +62,10 @@ jobs:
Spellcheck: Spellcheck:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
# The checkout step # The checkout step
- uses: actions/checkout@master - uses: actions/checkout@master
- uses: rojopolis/spellcheck-github-actions@0.11.0 - uses: rojopolis/spellcheck-github-actions@0.11.0
name: Spellcheck name: Spellcheck
with: with:
source_files: 'website/docs/*.md' source_files: "website/docs/*.md"
task_name: Markdown task_name: Markdown

View File

@ -5,9 +5,7 @@ on:
branches: branches:
- master - master
paths: paths:
- '.github/workflows/dockerbuild.yml' - "website/**"
- '.github/workflows/Pull_Request.yml'
- 'website/**'
jobs: jobs:
cd: cd:
@ -26,5 +24,24 @@ jobs:
run: | run: |
docker build -t ${GITHUB_REPOSITORY}:${{ steps.vars.outputs.branch }}-${{ steps.vars.outputs.sha_short }} . docker build -t ${GITHUB_REPOSITORY}:${{ steps.vars.outputs.branch }}-${{ steps.vars.outputs.sha_short }} .
docker push ${GITHUB_REPOSITORY}:${{ steps.vars.outputs.branch }}-${{ steps.vars.outputs.sha_short }} docker push ${GITHUB_REPOSITORY}:${{ steps.vars.outputs.branch }}-${{ steps.vars.outputs.sha_short }}
netlify-deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Use Node.js 12.x
uses: actions/setup-node@v1
with:
node-version: 12.x
# Run npm install and build on our code
- run: |
cd website
npm install
npm run build
# Deploy to Netlify using our production secrets
- uses: netlify/actions/cli@master
env:
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
with:
args: deploy --dir=website/build --prod

View File

@ -693,6 +693,12 @@ ZTN
html html
XXXXXXXXXXXXXXX XXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXX XXXXXXXXXXXXXXXXXXX
Worklfow
LitmusPortal
abc
litmusctl
subcommand
Litmusctl
gz gz
zxvf zxvf
MacOS MacOS
@ -712,4 +718,4 @@ CertManager
installCRDs installCRDs
jetstack jetstack
ClusterMode ClusterMode
LetsEncrypt LetsEncrypt

View File

@ -24,11 +24,11 @@ Additional details on the Docusaurus project can be found [here](https://docusau
## For Developers ## For Developers
### Clone litmus-docs repository ### Clone litmus-docs-beta repository
```bash ```bash
git clone https://github.com/litmuschaos/litmus-docs.git git clone https://github.com/litmuschaos/litmus-docs-beta.git
cd litmus-docs cd litmus-docs-beta
``` ```
The docs website server can be setup manually or through docker compose The docs website server can be setup manually or through docker compose

View File

@ -13,7 +13,6 @@ As part of Litmus installation by default, a self cluster would be registered as
As you are aware by now, Portal is a Cross Cloud Chaos Control plane. That is you can connect multiple external kubernetes agents to this portal. Once connected you can manage the chaos from the Portal that is you can induce chaos into this agent from the Portal and observe the results from the Portal. Using the command line utility _litmusctl_ you can connect the external agents to the Portal. As you are aware by now, Portal is a Cross Cloud Chaos Control plane. That is you can connect multiple external kubernetes agents to this portal. Once connected you can manage the chaos from the Portal that is you can induce chaos into this agent from the Portal and observe the results from the Portal. Using the command line utility _litmusctl_ you can connect the external agents to the Portal.
# Litmusctl # Litmusctl
Litmusctl is a command line interface to manage LitmusPortal services. Litmusctl is a command line interface to manage LitmusPortal services.