Skip to content

Commit c531ae1

Browse files
Silic0nS0ldierSilic0nS0ldier
authored
Merge pull request #29 from userfrosting/develop
Changed to GitHub Actions for CI, added API docs, bump dependencies
2 parents f7b6ae6 + a0b4af7 commit c531ae1

45 files changed

Lines changed: 1805 additions & 1233 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/ci.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Continuous Integration
2+
on:
3+
# Every push
4+
push:
5+
schedule:
6+
# Every Monday and Thursday at 12PM UTC
7+
- cron: '0 12 * * 1,4'
8+
9+
jobs:
10+
test:
11+
strategy:
12+
matrix:
13+
platform: [ ubuntu-latest, macos-latest, windows-latest ]
14+
node-version: [ 8.x, 10.x, 12.x, 13.x ]
15+
runs-on: ${{ matrix.platform }}
16+
steps:
17+
- uses: actions/checkout@v1
18+
- uses: actions/setup-node@v1
19+
with:
20+
version: ${{ matrix.node-version }}
21+
- run: npm ci
22+
- run: ./node_modules/.bin/nyc --reporter=lcovonly npm test
23+
- uses: codecov/codecov-action@v1
24+
with:
25+
token: ${{ secrets.CODECOV_UPLOAD_TOKEN }}

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ npm-debug.log
33
dist/
44
.nyc_output
55
coverage
6+
temp

‎.npmignore‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
1-
.travis.yml
2-
src/
31
!dist/
4-
**/*.test.js
2+
.editorconfig
3+
.gitattributes
4+
.nyc_output/
5+
.travis.yml
56
**/*.test.d.ts
7+
**/*.test.js
8+
**/*.test.js.map
9+
api-extractor.json
610
dist/index.d.ts
11+
src/
12+
temp/
13+
test-data/
714
tsconfig.json
8-
.gitattributes
15+
.github

‎.travis.yml‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎CHANGELOG.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
77

88
## [Unreleased]
99

10+
Maintenance release.
11+
- Bumped dependency versions
12+
- Applied fix for type validation in unit tests
13+
- Transferred CI onto GitHub Actions from Travis
14+
- Added API Documentation
15+
1016
## [3.0.2] - 2019-07-14
1117

1218
### Added
1319
- Increased test coverage (back to 100%).
1420

15-
## Changed
21+
### Changed
1622
- Updated dependencies.
1723
- Consolidated file tracking type definition into single source of truth.
1824
- Updated Travis CI config.

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,8 @@ This approach was decided on as it provides the most efficient means to integrat
7474

7575
## API
7676

77-
Generation of API documentation is not yet implemented however the API surface is fully documented interally. Use VS Code or look at the source on GitHub in the meantime.
77+
API documentation is regenerated for every release using [API Extractor](https://www.npmjs.com/package/@microsoft/api-extractor) and [API Documenter](https://www.npmjs.com/package/@microsoft/api-documenter).
78+
The results reside in [docs/api](./docs/api/index.md).
7879

7980
## History
8081

‎api-extractor.json‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
3+
"projectFolder": "./",
4+
"mainEntryPointFilePath": "<projectFolder>/dist/main.d.ts",
5+
"apiReport": {
6+
"enabled": false
7+
},
8+
"dtsRollup": {
9+
"enabled": false
10+
},
11+
"docModel": {
12+
"enabled": true
13+
}
14+
}

‎docs/api/gulp-bundle-assets.bundle.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@userfrosting/gulp-bundle-assets](./gulp-bundle-assets.md) &gt; [Bundle](./gulp-bundle-assets.bundle.md)
4+
5+
## Bundle interface
6+
7+
Represents an asset bundle
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export interface Bundle
13+
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [options](./gulp-bundle-assets.bundle.options.md) | <code>Options</code> | |
20+
| [scripts](./gulp-bundle-assets.bundle.scripts.md) | <code>string[]</code> | |
21+
| [styles](./gulp-bundle-assets.bundle.styles.md) | <code>string[]</code> | |
22+

‎docs/api/gulp-bundle-assets.bundle.options.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@userfrosting/gulp-bundle-assets](./gulp-bundle-assets.md) &gt; [Bundle](./gulp-bundle-assets.bundle.md) &gt; [options](./gulp-bundle-assets.bundle.options.md)
4+
5+
## Bundle.options property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
options?: Options;
11+
```

‎docs/api/gulp-bundle-assets.bundle.scripts.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@userfrosting/gulp-bundle-assets](./gulp-bundle-assets.md) &gt; [Bundle](./gulp-bundle-assets.bundle.md) &gt; [scripts](./gulp-bundle-assets.bundle.scripts.md)
4+
5+
## Bundle.scripts property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
scripts?: string[];
11+
```

0 commit comments

Comments
 (0)