Skip to content

Commit 2bcb69c

Browse files
estruyfestruyf
committed
Documentation + CircleCI integration
1 parent 546166c commit 2bcb69c

28 files changed

+14057
-17
lines changed

‎.circleci/config.yml

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
defaults: &defaults
2+
working_directory: ~/sp-dev-fx-controls-react
3+
docker:
4+
- image: circleci/node:6.11.5
5+
6+
version: 2
7+
jobs:
8+
build:
9+
<<: *defaults
10+
steps:
11+
- checkout
12+
- attach_workspace:
13+
at: ~/sp-dev-fx-controls-react
14+
- restore_cache:
15+
key: dependency-cache-{{ checksum "package.json" }}
16+
- run:
17+
name: Restore dependencies
18+
command: npm i
19+
- save_cache:
20+
key: dependency-cache-{{ checksum "package.json" }}
21+
paths:
22+
- ./node_modules
23+
- run:
24+
name: build
25+
command: npm run build
26+
- persist_to_workspace:
27+
root: .
28+
paths: .
29+
test:
30+
<<: *defaults
31+
steps:
32+
- attach_workspace:
33+
at: ~/sp-dev-fx-controls-react
34+
- run:
35+
name: Test
36+
command: npm test
37+
- run:
38+
name: Run coveralls
39+
command: 'cat temp/coverage/coverage.txt | ./node_modules/.bin/coveralls'
40+
- store_artifacts:
41+
path: coverage
42+
prefix: coverage
43+
publish_next:
44+
<<: *defaults
45+
steps:
46+
- attach_workspace:
47+
at: ~/sp-dev-fx-controls-react
48+
- run:
49+
name: Write .npmrc
50+
command: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> ~/.npmrc
51+
- run:
52+
name: Stamp beta to package version
53+
command: node scripts/update-package-version.js $CIRCLE_SHA1
54+
- run:
55+
name: Publish @next
56+
command: npm publish --tag next --access public
57+
publish:
58+
<<: *defaults
59+
steps:
60+
- attach_workspace:
61+
at: ~/sp-dev-fx-controls-react
62+
- run:
63+
name: Write .npmrc
64+
command: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> ~/.npmrc
65+
- run:
66+
name: Publish
67+
command: npm publish --access public
68+
deploy_docs:
69+
working_directory: ~/sp-dev-fx-controls-react/docs/documentation
70+
docker:
71+
- image: circleci/python:2.7-jessie-node
72+
steps:
73+
- attach_workspace:
74+
at: ~/sp-dev-fx-controls-react
75+
- add_ssh_keys:
76+
fingerprints:
77+
- "06:6f:8d:29:ab:79:c3:6a:61:85:9e:37:93:34:a9:bb"
78+
- run:
79+
name: Install MkDocs
80+
command: sudo pip install mkdocs
81+
- run:
82+
name: Avoid hosts unknown for github
83+
command: echo -e "Host github.com\n\tStrictHostKeyChecking no\n" > ~/.ssh/config
84+
- run:
85+
name: build docs
86+
command: mkdocs gh-deploy
87+
88+
workflows:
89+
version: 2
90+
release_next:
91+
jobs:
92+
- build:
93+
filters:
94+
branches:
95+
only: dev
96+
- test:
97+
requires:
98+
- build
99+
filters:
100+
branches:
101+
only: dev
102+
- publish_next:
103+
requires:
104+
- test
105+
filters:
106+
branches:
107+
only: dev
108+
release:
109+
jobs:
110+
- build:
111+
filters:
112+
tags:
113+
only: /^v[0-9]+\.[0-9]+\.[0-9]+/
114+
branches:
115+
ignore: /.*/
116+
- test:
117+
requires:
118+
- build
119+
filters:
120+
tags:
121+
only: /^v[0-9]+\.[0-9]+\.[0-9]+/
122+
branches:
123+
ignore: /.*/
124+
- publish:
125+
requires:
126+
- test
127+
filters:
128+
tags:
129+
only: /^v[0-9]+\.[0-9]+\.[0-9]+/
130+
branches:
131+
ignore: /.*/
132+
- deploy_docs:
133+
requires:
134+
- publish
135+
filters:
136+
tags:
137+
only: /^v[0-9]+\.[0-9]+\.[0-9]+/
138+
branches:
139+
ignore: /.*/

‎.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,3 +36,6 @@ obj
3636

3737
# VSCode
3838
.vscode
39+
40+
# Documentation
41+
docs/documentation/site

‎.npmignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ typings
1010
lib/webparts
1111
assets
1212
dist
13+
docs
14+
scripts
15+
.circleci
1316

1417
# Files
1518
*.csproj

‎README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This is a open source library that shares a set of reusable React control that c
88
99
## Get Started
1010

11-
More information to get started can be found in the wiki section of this repository: [wiki / documentation](https://github.com/SharePoint/sp-dev-fx-controls-react/wiki).
11+
More information to get started can be found documentation of this repository: [documentation](https://sharepoint.github.io/sp-dev-fx-controls-react/).
1212

1313
# Have issues or questions?
1414

‎config/karma.config.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ module.exports = function (config) {
2828
config.remapCoverageReporter = {
2929
'text-summary': null,
3030
html: path.join(gulp_core_build.getConfig().tempFolder, 'coverage/html'),
31-
cobertura: path.join(gulp_core_build.getConfig().tempFolder, 'coverage/cobertura.xml')
31+
cobertura: path.join(gulp_core_build.getConfig().tempFolder, 'coverage/cobertura.xml'),
32+
lcovonly: path.join(gulp_core_build.getConfig().tempFolder, 'coverage/coverage.txt')
3233
};
3334
config.plugins.push(remapCoverageReporter);
3435
};

‎docs/documentation/docs/about/license.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
License
2+
3+
Copyright (c) Microsoft Corporation. All rights reserved.
4+
5+
MIT License
6+
7+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
8+
9+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
10+
11+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎docs/documentation/docs/about/release-notes.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Releases
2+
3+
## Beta 1.0.0-beta.8
4+
- **Bug fix**: bug fix for the `ListView` control when selection is used in combination with `setState`.
5+
6+
## Beta 1.0.0-beta.7
7+
**Added**
8+
- Grouping functionality added to the `ListView` control
9+
10+
## Beta 1.0.0-beta.6
11+
- Initial release

‎docs/documentation/docs/assets/FileTypeIcon.png

10.7 KB
Loading

‎docs/documentation/docs/assets/ListView-grouping.png

38.3 KB
Loading

‎docs/documentation/docs/assets/ListView.png

35 KB
Loading

0 commit comments

Comments
 (0)