b2a35145c9
* Add extra help for Explainer link(s) * Restructure text, move a couple lines to prototyping * Changes as suggested. * Update from comments. * formatting |
||
|---|---|---|
| .devcontainer | ||
| .github | ||
| api | ||
| client-src | ||
| data | ||
| framework | ||
| internals | ||
| pages | ||
| scripts | ||
| static | ||
| templates | ||
| .babelrc | ||
| .coveragerc | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc | ||
| .gcloudignore | ||
| .gitignore | ||
| CODE_OF_CONDUCT.md | ||
| LICENSE | ||
| README.md | ||
| app.staging.yaml | ||
| app.yaml | ||
| appengine_config.py | ||
| config.rb | ||
| cron.yaml | ||
| developer-documentation.md | ||
| dispatch.yaml | ||
| gulpfile.babel.js | ||
| hack_components.py | ||
| index.yaml | ||
| main.py | ||
| main_test.py | ||
| notifier.staging.yaml | ||
| notifier.yaml | ||
| package-lock.json | ||
| package.json | ||
| queue.yaml | ||
| requirements.dev.txt | ||
| requirements.txt | ||
| settings.py | ||
| testing_config.py | ||
README.md
Chrome Platform Status
Mission
chromestatus.com is the official tool used for for tracking feature launches in Blink (the browser engine that powers Chrome and many other web browsers). This tool guides feature owners through our launch process and serves as a primary source for developer information that then ripples throughout the web developer ecosystem.
Get the code
For a one-click setup that leverages devcontainers, check out the devcontainer README. Otherwise, to continue setting up locally:
git clone https://github.com/GoogleChrome/chromium-dashboard
Installation
- Install gcloud and needed components:
- Before you begin, make sure that you have a java JRE (version 8 or greater) installed. JRE is required to use the DataStore Emulator.
- Google App Engine SDK for Python. Make sure to select Python 3.
gcloud initgcloud components install cloud-datastore-emulatorgcloud components install beta
- Install other developer tools commands
- node and npm.
- Gulp:
npm install --global gulp-cli - Python virtual environment:
sudo apt install python3.10-venv
- We recommend using an older node version, e.g. node 18
- Use
node -vto check the default node version nvm use 18to switch to node 18
- Use
cd chromium-dashboard- Install JS an python dependencies:
npm run setup- Note: Whenever we make changes to package.json or requirements.txt, you will need to run
npm run clean-setup.
- Note: Whenever we make changes to package.json or requirements.txt, you will need to run
If you encounter any error during the installation process, the section Notes (later in this README.md) may help.
Developing
To start the main server and the notifier backend, run:
npm start
Then visit http://localhost:8080/.
To start front end code watching (sass, js lint check, babel, minify files), run
npm run watch
To run lint & lit-analyzer:
npm run lint
To run unit tests:
npm test
This will start a local datastore emulator, run unit tests, and then shut down the emulator.
There are some developing information in developer-documentation.md.
Notes
-
If you get an error saying
No module named protobuforNo module named sixorNo module named enum, try installing them locally withpip install six enum34 protobuf. -
When installing the GAE SDK, make sure to get the version for python 3.
-
If you run the server locally, and then you are disconnected from your terminial window, the jobs might remain running which will prevent you from starting the server again. To work around this, use
npm run stop-emulator; npm stop. Or, useps aux | grep gunicornand/orps aux | grep emulator, then use the unixkill -9command to terminate those jobs. -
If you need to test or debug anything to do with dependencies, you can get a clean start by running
npm run clean-setup. -
Occasionally, the Google Cloud CLI will requires an update, which will cause a failure when trying to run the development server with
npm start. An unrelated error messageFailed to connect to localhost port 15606 after 0 ms: Connection refusedwill appear. Running thegcloud components updatecommand will update as needed and resolve this issue.
Blink components
Chromestatus currently gets the list of Blink components from the file hack_components.py.
Seed the blink component owners
Visit http://localhost:8080/admin/blink/populate_blink to see the list of Blink component owners.
Debugging / settings
settings.py contains a list
of globals for debugging and running the site locally.
Deploying
If you have uncommited local changes, the appengine version name will end with -tainted.
It is OK to test on staging with tainted versions, but everything should be committed
(and thus not tainted) before staging a version that can later be pushed to prod.
Note you need to have admin privileges on the cr-status-staging and cr-status
cloud projects to be able to deploy the site.
Run the npm target:
npm run staging
Open the Google Developer Console for the staging site and flip to the new version by selecting from the list and clicking MIGRATE TRAFFIC. Make sure to do this for both the 'default' service as well as for the 'notifier' service.
Alternatively, run npm run staging-rc to upload the same code to a version named rc for "Release candidate". This is the only version that you can test using Google Sign-In at https://rc-dot-cr-status-staging.appspot.com.
If manual testing on the staging server looks good, then repeat the same steps to deploy to prod:
npm run deploy
Open the Google Developer Console for the production site
The production site should only have versions that match versions on staging.
LICENSE
Copyright (c) 2013-2022 Google Inc. All rights reserved.
Apache2 License.