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

Update README.md #203

Merged
merged 2 commits into from
Sep 19, 2022
Merged

Update README.md #203

merged 2 commits into from
Sep 19, 2022

Conversation

sunnylqm
Copy link
Contributor

No description provided.

@sunnylqm sunnylqm requested a review from a team as a code owner September 19, 2022 13:20
Copy link
Member

@mattcosta7 mattcosta7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the suggestions here. A few small thoughts

@@ -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
Copy link
Member

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

Copy link
Contributor Author

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

Copy link
Member

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 time

we could add a single note about versioning, directing to the docs for that

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

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!

runs-on: ubuntu-latest
needs: [build-base, build-head]
steps:
- uses: actions/download-artifact@v3
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should probably avoid including a version here

needs: [build-base, build-head]
steps:
- uses: actions/download-artifact@v3
- uses: github/webpack-bundlesize-compare-action@v1.5.0
Copy link
Member

Choose a reason for hiding this comment

The 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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- uses: github/webpack-bundlesize-compare-action@v1.5.0
# Run the comparison action
# Remember to use a specific sha or version
# github/webpack-bundlesize-compare-action@v<x.x.x> or github/webpack-bundlesize-compare-action@<sha>
- uses: github/webpack-bundlesize-compare-action

Copy link
Contributor Author

Choose a reason for hiding this comment

The 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"

Copy link
Contributor Author

@sunnylqm sunnylqm Sep 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mattcosta7 mattcosta7 merged commit 63c6ef8 into github:main Sep 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants