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.

Sign up for GitHub

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

misc: more releasing tweaks #9772

Merged
merged 1 commit into from
Oct 11, 2019
Merged

misc: more releasing tweaks #9772

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 3 additions & 7 deletions docs/releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ and that no new PRs should be merged until you are done.
```sh
# Run the tests.
bash ./lighthouse-core/scripts/release/test.sh
# Change into the pristine folder.
# Change into the newly-created pristine folder.
Copy link
Member Author

Choose a reason for hiding this comment

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

this is confusing unless you realize it was just created for you

cd ../lighthouse-pristine
```

Expand All @@ -85,7 +85,7 @@ yarn --cwd ~/chromium/src/third_party/blink/renderer/devtools test 'http/tests/d
git diff

# Verify that the Audits panel still works. Consider the new features that have been added.
# If anything is wrong, stop releasing, investigate, and prioritize landing the PR.
# If anything is wrong, stop releasing, investigate, land a fix and start over.

# For bonus points, add some tests covering new features. Either a new test, or an extra
# assertion in an existing test.
Expand All @@ -105,7 +105,7 @@ Confirm Lightrider integration will work:

# Verify that Lightrider works properly, and is generating reports fully. Consider the new features that have been added.
# Note: if the changes include proto changes make sure that the API has those new fields.
# If anything is wrong, stop releasing, investigate, and prioritize landing the PR.
# If anything is wrong, stop releasing, investigate, land a fix and start over.

# For bonus points, add some tests covering new features. Either a new test, or an extra
# assertion in an existing test.
Expand All @@ -114,10 +114,6 @@ Confirm Lightrider integration will work:
Now that the integrations are confirmed to work, go back to `lighthouse` folder.

```sh
# Run the tests again.
# Note: you can skip this if you didn't need to land any changes.
bash ./lighthouse-core/scripts/release/test.sh
Copy link
Member Author

Choose a reason for hiding this comment

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

this doesn't really make sense here (if you've just had to land a PR you should be starting over)


# Prepare the commit, replace x.x.x with the desired version
bash ./lighthouse-core/scripts/release/prepare-commit.sh x.x.x

Expand Down
5 changes: 1 addition & 4 deletions lighthouse-core/scripts/release/test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,6 @@ yarn build-all
echo "Running the standard test suite..."
yarn test

echo "Running the smoke tests...."
yarn smoke || yarn smoke || yarn smoke
Copy link
Member Author

Choose a reason for hiding this comment

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

this is not really necessary.

  • in theory, master is green. yarn test is a nice sanity check, but running all the smoke tests is overkill because
  • they're about to be run again in the packaged pristine version and
  • it's incredibly annoying to have to run this all over again if master is still green but there's some hiccup further down in this script :)


echo "Testing the CLI..."
yarn start "https://example.com" --view

Expand All @@ -39,7 +36,7 @@ cd /tmp/lighthouse-local-test

npm init -y
npm install "$LH_PRISTINE_ROOT/lighthouse-$VERSION.tgz"
npm explore lighthouse -- npm run smoke
npm explore lighthouse -- npm run smoke || npm explore lighthouse -- npm run smoke
Copy link
Member Author

Choose a reason for hiding this comment

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

and it's nice to run this twice just in case there's some flake (like I just experienced)

Copy link
Collaborator

Choose a reason for hiding this comment

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

should we make it three like we just removed above? :)

Copy link
Collaborator

Choose a reason for hiding this comment

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

wanna lift the bash-ism i used in #9766 ?

Copy link
Collaborator

Choose a reason for hiding this comment

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

FWIW connor that actually required significant cognitive overhead for me to verify it's doing what we want it to do. when it's only a couple times, I'd greatly prefer || <repeat>

npm explore lighthouse -- npm run chrome # try the manual launcher
npm explore lighthouse -- npm run fast -- http://example.com

Expand Down