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

Add api extractor #68

Merged
merged 24 commits into from
Mar 16, 2021
Merged
Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
e77dbe0
Add api extractor and script commands
JamesBurnside Mar 12, 2021
dee3712
Add ci action and add a quick change to test when CI fails
JamesBurnside Mar 12, 2021
619da31
Merge remote-tracking branch 'origin/main' into jaburnsi/add-api-extr…
JamesBurnside Mar 12, 2021
e29e3e3
Add missing api file
JamesBurnside Mar 12, 2021
692eb1e
Merge remote-tracking branch 'origin/main' into jaburnsi/add-api-extr…
JamesBurnside Mar 12, 2021
1550f46
Merge remote-tracking branch 'origin/main' into jaburnsi/add-api-extr…
JamesBurnside Mar 13, 2021
1b3f2e1
fix up communication-ui doc warnings
JamesBurnside Mar 13, 2021
decd2f9
Fix warnings in declarative packages
JamesBurnside Mar 13, 2021
b39eed7
Add changefiles
JamesBurnside Mar 13, 2021
927b318
Quickly fix lack of change files not blocking PR
JamesBurnside Mar 13, 2021
c5e0fcc
remove extra quote
JamesBurnside Mar 15, 2021
785d8d2
update api now failing ci build is proven
JamesBurnside Mar 15, 2021
3b11453
Merge branch 'main' into jaburnsi/add-api-extractor
JamesBurnside Mar 15, 2021
82c2345
Update output folder from etc to review, add forgotten export warning…
JamesBurnside Mar 15, 2021
531027c
PR nits
JamesBurnside Mar 15, 2021
23f8460
Merge branch 'jaburnsi/add-api-extractor' of github.com:Azure/communi…
JamesBurnside Mar 15, 2021
2422648
padte folder name in ci task
JamesBurnside Mar 15, 2021
78f1399
update api
JamesBurnside Mar 15, 2021
47de19e
Merge remote-tracking branch 'origin/main' into jaburnsi/add-api-extr…
JamesBurnside Mar 16, 2021
f22519f
Update as-chat-selector pkg with api-extractor
JamesBurnside Mar 16, 2021
604d201
Apply better solution for api-extractor bug in useFetchMessages
JamesBurnside Mar 16, 2021
0135721
change file
JamesBurnside Mar 16, 2021
61f1a7b
fix linting
JamesBurnside Mar 16, 2021
dad1441
typo
JamesBurnside Mar 16, 2021
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
25 changes: 21 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,6 @@ jobs:
- name: Install dependencies
run: rush install

# Perform changelog check
JamesBurnside marked this conversation as resolved.
Show resolved Hide resolved
- name: Check the necessary change file has been submitted
run: rush changelog:check

# Perform lint check
- name: Run linter
run: rush lint
Expand All @@ -47,6 +43,27 @@ jobs:
run: rushx build:storybook
working-directory: ./packages/communication-ui

# Verify no uncommitted api extractor changes
- name: API Extractor Check
run: |
DIFF_FILE="APIChanges.diff"
git diff --output=$DIFF_FILE --exit-code packages/**/etc/**.md
DIFF_STATUS=$?
echo "Exit code for git diff for changes in api review files: $DIFF_STATUS"
if [$DIFF_STATUS -ne 0]
then
echo "API CHANGES FOUND - PLEASE RUN 'rushx api-extractor' IN THE APPROPRIATE PACKAGE(S)"
echo "Changes:"
cat $DIFF_FILE
exit 1
else
echo "Success, no new api changes found."
fi

# Perform changelog check
- name: Check the necessary change file has been submitted
run: rush changelog:check

# Run tests
- name: Run Tests
run: rush test
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -86,3 +86,5 @@ junit.xml
# Common build folders
dist/
build/
temp/
docGen/
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "prerelease",
"comment": "Add api extractor for package",
"packageName": "@azure/acs-calling-declarative",
"email": "mail@jamesburnside.com",
"dependentChangeType": "patch"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "prerelease",
"comment": "Add api extractor for package",
"packageName": "@azure/acs-chat-declarative",
"email": "mail@jamesburnside.com",
"dependentChangeType": "patch"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "prerelease",
"comment": "Add api extractor for package",
"packageName": "@azure/communication-ui",
"email": "mail@jamesburnside.com",
"dependentChangeType": "patch"
}
28 changes: 28 additions & 0 deletions common/api-extractor/api-extractor.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"mainEntryPointFilePath": "<projectFolder>/dist/index.d.ts",
"apiReport": {
"enabled": true
},
"docModel": {
"enabled": true
},
"dtsRollup": {
"enabled": true
},
"messages": {
"extractorMessageReporting": {
"ae-missing-release-tag": {
"logLevel": "none"
},
"ae-unresolved-link": {
"logLevel": "none"
}
},
"tsdocMessageReporting": {
"tsdoc-undefined-tag": {
"logLevel": "none"
}
}
}
}
Loading