-
Notifications
You must be signed in to change notification settings - Fork 21
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
Update README.md #203
Update README.md #203
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -56,7 +56,7 @@ jobs: | |||||||||||
- name: Build | ||||||||||||
run: npm run build | ||||||||||||
- name: Upload stats.json | ||||||||||||
uses: actions/upload-artifact@v1 | ||||||||||||
uses: actions/upload-artifact@v3 | ||||||||||||
with: | ||||||||||||
name: head-stats | ||||||||||||
path: ./dist/stats.json | ||||||||||||
|
@@ -78,19 +78,23 @@ jobs: | |||||||||||
- name: Build | ||||||||||||
run: npm run build | ||||||||||||
- name: Upload stats.json | ||||||||||||
uses: actions/upload-artifact@v1 | ||||||||||||
uses: actions/upload-artifact@v3 | ||||||||||||
with: | ||||||||||||
name: base-stats | ||||||||||||
path: ./dist/stats.json | ||||||||||||
|
||||||||||||
# run the action against the stats.json files | ||||||||||||
compare: | ||||||||||||
name: 'Compare base & head bundle sizes' | ||||||||||||
uses: github/webpack-bundlesize-compare-action # you should probably lock to a sha of a version to avoid potentially breaking changes | ||||||||||||
with: | ||||||||||||
github-token: ${{ secrets.GITHUB_TOKEN }} | ||||||||||||
current-stats-json-path: ./head-stats/stats.json | ||||||||||||
base-stats-json-path: ./base-stats/stats.json | ||||||||||||
runs-on: ubuntu-latest | ||||||||||||
needs: [build-base, build-head] | ||||||||||||
steps: | ||||||||||||
- uses: actions/download-artifact@v3 | ||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. we should probably avoid including a version here |
||||||||||||
- uses: github/webpack-bundlesize-compare-action@v1.5.0 | ||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't think we should include a specific version here, otherwise we're likely to forget to add this when the next release occurs. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. version is required and as an example it may be better for people to just "copy-paste-go" There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. AFAIK most action examples write this way |
||||||||||||
with: | ||||||||||||
github-token: ${{ secrets.GITHUB_TOKEN }} | ||||||||||||
current-stats-json-path: ./head-stats/stats.json | ||||||||||||
base-stats-json-path: ./base-stats/stats.json | ||||||||||||
``` | ||||||||||||
|
||||||||||||
## Options | ||||||||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it might be better to avoid suggesting the version at all here, otherwise we'll need to updatet the docs as this changes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
but version is required for real case
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't believe that's true? most actions use
main
if no version is provided. Users should use a version, but adding details about that here doesn't seem helpful to say they must use a specific version if that's not true all the timewe could add a single note about versioning, directing to the docs for that
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://github.com/OneKeyHQ/app-monorepo/actions/runs/3068822764/workflow#L56
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hm - interesting, it shouldn't be required, but maybe related to how versions are tagged currently, thanks!