3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-01 10:22:30 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update CircleCI info

Browse source 
Show how you can make it so CircleCI only runs when a commit is directly made to the `master` branch.
This commit is contained in:
Joel Marcey 2018-03-16 12:38:19 -07:00 • committed by GitHub
parent e798618ed2
commit f41b207333
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/getting-started-publishing.md
View file

@ -86,6 +86,15 @@ If you haven't done so already, you can [setup CircleCI](https://circleci.com/si
1. Copy the text below into `.circleci/config.yml`.
```yml
# If you only one circle to run on direct commits to master, you can uncomment this out
# and uncomment the filters: *filter-only-master down below too
#
# aliases:
# - &filter-only-master
# branches:
# only:
# - master
version: 2
jobs:
deploy-website:
@ -108,6 +117,7 @@ workflows:
build_and_deploy:
jobs:
- deploy-website
# filters: *filter-only-master
```
Make sure to replace all `<....>` in the `command:` sequence with appropriate values. For `<GIT_USER>`, it should be a GitHub account that has access to push documentation to your GitHub repo. Many times `<GIT_USER>` and `<GITHUB_USERNAME>` will be the same.