Skip to content

Commit 1a97bd8

Browse files
author
Paul Boocock
committed
Automate api-extractor on release (close #972)
1 parent ecc0040 commit 1a97bd8

File tree

64 files changed

+1338
-96
lines changed

Some content is hidden

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

64 files changed

+1338
-96
lines changed

‎.github/workflows/change_check.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,17 @@ jobs:
3232

3333
- name: Verify change files
3434
run: node common/scripts/install-run-rush.js change --verify
35+
36+
- name: Rush Build
37+
run: node common/scripts/install-run-rush.js rebuild --verbose
38+
39+
- name: Install API Extractor
40+
run: npm install -g @microsoft/api-extractor@^7.18.4
41+
42+
- name: Check for API changes to @snowplow/browser-tracker
43+
working-directory: ./trackers/browser-tracker
44+
run: api-extractor run
45+
46+
- name: Check for API changes to @snowplow/node-tracker
47+
working-directory: ./trackers/node-tracker
48+
run: api-extractor run

‎.github/workflows/publish.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,28 @@ jobs:
5959
- name: Rush Test
6060
run: node common/scripts/install-run-rush.js test --verbose
6161

62+
- name: Install API Extractor & Documenter
63+
run: npm install -g @microsoft/api-extractor@^7.18.4 @microsoft/api-documenter@^7.13.34
64+
65+
- name: Create API documentation for @snowplow/browser-tracker
66+
working-directory: ./trackers/browser-tracker
67+
run: |
68+
api-extractor run
69+
api-documenter markdown --input-folder temp --output-folder docs/markdown
70+
71+
- name: Create API documentation for @snowplow/node-tracker
72+
working-directory: ./trackers/node-tracker
73+
run: |
74+
api-extractor run
75+
api-documenter markdown --input-folder temp --output-folder docs/markdown
76+
77+
- name: Apply API documentation updates
78+
run: |
79+
git add trackers/browser-tracker/docs
80+
git add trackers/node-tracker/docs
81+
git commit --no-verify --allow-empty -m "Applying documentation updates."
82+
git push
83+
6284
- name: Rush Publish
6385
run: node common/scripts/install-run-rush.js publish --apply --include-all --publish --target-branch master --set-access-level public --ignore-git-hooks
6486

‎.github/workflows/publish_prerelease.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,21 @@ jobs:
5959
- name: Rush Test
6060
run: node common/scripts/install-run-rush.js test --verbose
6161

62+
- name: Install API Extractor & Documenter
63+
run: npm install -g @microsoft/api-extractor@^7.18.4 @microsoft/api-documenter@^7.13.34
64+
65+
- name: Create API documentation for @snowplow/browser-tracker
66+
working-directory: ./trackers/browser-tracker
67+
run: |
68+
api-extractor run
69+
api-documenter markdown --input-folder temp --output-folder docs/markdown
70+
71+
- name: Create API documentation for @snowplow/node-tracker
72+
working-directory: ./trackers/node-tracker
73+
run: |
74+
api-extractor run
75+
api-documenter markdown --input-folder temp --output-folder docs/markdown
76+
6277
- name: Rush Publish
6378
run: node common/scripts/install-run-rush.js publish --apply --include-all --publish --tag next --set-access-level public --ignore-git-hooks
6479

‎common/changes/@snowplow/browser-plugin-ecommerce/972_2021-08-03-11-53.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"changes": [
3+
{
4+
"packageName": "@snowplow/browser-plugin-ecommerce",
5+
"comment": "Automate api-extractor on release (#972)",
6+
"type": "none"
7+
}
8+
],
9+
"packageName": "@snowplow/browser-plugin-ecommerce"
10+
}

‎common/changes/@snowplow/browser-plugin-geolocation/972_2021-08-03-11-53.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"changes": [
3+
{
4+
"packageName": "@snowplow/browser-plugin-geolocation",
5+
"comment": "Automate api-extractor on release (#972)",
6+
"type": "none"
7+
}
8+
],
9+
"packageName": "@snowplow/browser-plugin-geolocation"
10+
}

‎common/changes/@snowplow/browser-plugin-link-click-tracking/972_2021-08-03-11-53.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"changes": [
3+
{
4+
"packageName": "@snowplow/browser-plugin-link-click-tracking",
5+
"comment": "Automate api-extractor on release (#972)",
6+
"type": "none"
7+
}
8+
],
9+
"packageName": "@snowplow/browser-plugin-link-click-tracking"
10+
}

‎common/changes/@snowplow/browser-plugin-optimizely/972_2021-08-03-11-53.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"changes": [
3+
{
4+
"packageName": "@snowplow/browser-plugin-optimizely",
5+
"comment": "Automate api-extractor on release (#972)",
6+
"type": "none"
7+
}
8+
],
9+
"packageName": "@snowplow/browser-plugin-optimizely"
10+
}

‎common/changes/@snowplow/browser-plugin-performance-timing/972_2021-08-03-11-53.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"changes": [
3+
{
4+
"packageName": "@snowplow/browser-plugin-performance-timing",
5+
"comment": "Automate api-extractor on release (#972)",
6+
"type": "none"
7+
}
8+
],
9+
"packageName": "@snowplow/browser-plugin-performance-timing"
10+
}

‎common/changes/@snowplow/browser-plugin-timezone/972_2021-08-03-11-53.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"changes": [
3+
{
4+
"packageName": "@snowplow/browser-plugin-timezone",
5+
"comment": "Automate api-extractor on release (#972)",
6+
"type": "none"
7+
}
8+
],
9+
"packageName": "@snowplow/browser-plugin-timezone"
10+
}

‎common/changes/@snowplow/browser-tracker-core/972_2021-08-03-11-53.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"changes": [
3+
{
4+
"packageName": "@snowplow/browser-tracker-core",
5+
"comment": "Automate api-extractor on release (#972)",
6+
"type": "none"
7+
}
8+
],
9+
"packageName": "@snowplow/browser-tracker-core"
10+
}

0 commit comments

Comments
 (0)