Skip to content

Commit 4a92b99

Browse files
43081j43081j
authored
docs: move examples to recipes dir (#22)
* docs: move examples to recipes dir * docs: add list of recipes
1 parent c2d77d1 commit 4a92b99

File tree

3 files changed

+102
-68
lines changed

3 files changed

+102
-68
lines changed

‎README.md‎

Lines changed: 8 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,13 @@ jobs:
5858
size-threshold: '50000'
5959
```
6060

61+
## Example Workflows
62+
63+
See the [`recipes/`](./recipes/) directory for complete workflow examples:
64+
65+
- [`basic.yml`](./recipes/basic.yml) - Basic dependency diff on pull requests
66+
- [`bundle-diff.yml`](./recipes/bundle-diff.yml) - Advanced workflow with package bundle size analysis
67+
6168
## Package Bundle Analysis
6269

6370
In addition to analyzing dependency changes, this action can optionally compare the actual bundle sizes of your packages by examining `npm pack` outputs. This provides insights into the **bundle size** (what gets published) rather than just the **install size** (what gets installed with dependencies).
@@ -73,74 +80,7 @@ The action accepts glob patterns to locate package tarballs for comparison:
7380
> [!NOTE]
7481
> Package bundle analysis only runs when both `base-packages` and `source-packages` are provided. If these inputs are not set, this feature is skipped entirely.
7582

76-
### Example with package analysis
77-
78-
```yaml
79-
jobs:
80-
build-main:
81-
runs-on: ubuntu-latest
82-
steps:
83-
- name: Checkout
84-
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
85-
with:
86-
ref: main # or your default branch
87-
- name: Use Node
88-
uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
89-
with:
90-
node-version: 24.x
91-
- name: Install Dependencies
92-
run: npm ci --ignore-scripts
93-
- name: Build
94-
run: npm run build
95-
- name: Pack
96-
run: npm pack
97-
- uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
98-
with:
99-
name: base-packages
100-
path: '*.tgz'
101-
build-pr:
102-
runs-on: ubuntu-latest
103-
steps:
104-
- name: Checkout
105-
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
106-
- name: Use Node
107-
uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
108-
with:
109-
node-version: 24.x
110-
- name: Install Dependencies
111-
run: npm ci --ignore-scripts
112-
- name: Build
113-
run: npm run build
114-
- name: Pack
115-
run: npm pack
116-
- uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
117-
with:
118-
name: source-packages
119-
path: '*.tgz'
120-
diff_dependencies:
121-
runs-on: ubuntu-latest
122-
needs: [build-main, build-pr]
123-
permissions:
124-
pull-requests: write
125-
steps:
126-
- name: Checkout repository
127-
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
128-
with:
129-
fetch-depth: 0 # allows the diff action to access git history
130-
- uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
131-
with:
132-
name: base-packages
133-
path: ./base-packages
134-
- uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
135-
with:
136-
name: source-packages
137-
path: ./source-packages
138-
- name: Create Diff
139-
uses: e18e/action-dependency-diff@v1
140-
with:
141-
base-packages: ./base-packages/*.tgz
142-
source-packages: ./source-packages/*.tgz
143-
```
83+
You can see an example of how to set this up in the [bundle difference workflow](./recipes/bundle-diff.yml).
14484

14585
## Supported package managers
14686

‎recipes/basic.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Dependency Diff
2+
3+
on:
4+
pull_request:
5+
6+
jobs:
7+
diff_dependencies:
8+
runs-on: ubuntu-latest
9+
permissions:
10+
pull-requests: write
11+
steps:
12+
- name: Checkout repository
13+
uses: actions/checkout@v4
14+
with:
15+
fetch-depth: 0
16+
- name: Create Diff
17+
uses: e18e/action-dependency-diff@v1

‎recipes/bundle-diff.yml‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
name: Dependency Diff
2+
3+
on:
4+
pull_request:
5+
6+
jobs:
7+
build-main:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout
11+
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
12+
with:
13+
ref: main # or your default branch
14+
- name: Use Node
15+
uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
16+
with:
17+
node-version: 24.x
18+
19+
# These steps are whatever you need to build and pack your project.
20+
# Change them as necessary.
21+
- name: Install Dependencies
22+
run: npm ci --ignore-scripts
23+
- name: Build
24+
run: npm run build
25+
- name: Pack
26+
run: npm pack
27+
28+
- uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
29+
with:
30+
name: base-packages
31+
path: '*.tgz'
32+
build-pr:
33+
runs-on: ubuntu-latest
34+
steps:
35+
- name: Checkout
36+
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
37+
- name: Use Node
38+
uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
39+
with:
40+
node-version: 24.x
41+
42+
# These steps are whatever you need to build and pack your project.
43+
# Change them as necessary.
44+
- name: Install Dependencies
45+
run: npm ci --ignore-scripts
46+
- name: Build
47+
run: npm run build
48+
- name: Pack
49+
run: npm pack
50+
51+
- uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
52+
with:
53+
name: source-packages
54+
path: '*.tgz'
55+
diff_dependencies:
56+
runs-on: ubuntu-latest
57+
needs: [build-main, build-pr]
58+
permissions:
59+
pull-requests: write
60+
steps:
61+
- name: Checkout repository
62+
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
63+
with:
64+
fetch-depth: 0 # allows the diff action to access git history
65+
- uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
66+
with:
67+
name: base-packages
68+
path: ./base-packages
69+
- uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
70+
with:
71+
name: source-packages
72+
path: ./source-packages
73+
- name: Create Diff
74+
uses: e18e/action-dependency-diff@v1
75+
with:
76+
base-packages: ./base-packages/*.tgz
77+
source-packages: ./source-packages/*.tgz

0 commit comments

Comments
 (0)