aboutsummaryrefslogtreecommitdiffstats
path: root/packages/pipeline/README.md
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2019-01-11 07:47:57 +0800
committerFabio Berger <me@fabioberger.com>2019-01-11 07:47:57 +0800
commit583e690b7a028c85809a8be2c7afe3b65264adbe (patch)
treebc7ba2fe96833633455daaebf44d7382d0e20b7d /packages/pipeline/README.md
parenta516b00a0397a567fd233bd955206d46321cc178 (diff)
parenta5b7a351609a5e6689bb97990216153f64302462 (diff)
downloaddexon-sol-tools-583e690b7a028c85809a8be2c7afe3b65264adbe.tar
dexon-sol-tools-583e690b7a028c85809a8be2c7afe3b65264adbe.tar.gz
dexon-sol-tools-583e690b7a028c85809a8be2c7afe3b65264adbe.tar.bz2
dexon-sol-tools-583e690b7a028c85809a8be2c7afe3b65264adbe.tar.lz
dexon-sol-tools-583e690b7a028c85809a8be2c7afe3b65264adbe.tar.xz
dexon-sol-tools-583e690b7a028c85809a8be2c7afe3b65264adbe.tar.zst
dexon-sol-tools-583e690b7a028c85809a8be2c7afe3b65264adbe.zip
Merge branch 'development' into fix/dev-tools-pages/finalTouches
* development: (49 commits) upgrade to ddex api v3 (#1507) Add new deployment related instructions to pipeline README (#1499) feature: implement logging and friendly wallet name for Opera Fix prettier Add missing dependencies Remove second yarn call Add .gitkeep Rename sol-trace-based-tools-common to sol-tracing-utils Update packages/sol-trace/README.md Update packages/sol-trace/CHANGELOG.json Update packages/sol-trace-based-tools-common/src/source_maps.ts Update packages/sol-trace-based-tools-common/CHANGELOG.json Update packages/sol-profiler/CHANGELOG.json Update packages/sol-coverage/CHANGELOG.json Update packages/monorepo-scripts/src/test_installation.ts chore: changelog update fix: account for undefined errors in promisify, not only null Clean up docs before publish In README's, don't mention non-existent tests (#1497) fix: use getBackendBaseUrl instead of hardcoded string ...
Diffstat (limited to 'packages/pipeline/README.md')
-rw-r--r--packages/pipeline/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/packages/pipeline/README.md b/packages/pipeline/README.md
index 794488cac..40a64cdd1 100644
--- a/packages/pipeline/README.md
+++ b/packages/pipeline/README.md
@@ -147,6 +147,20 @@ set the`ZEROEX_DATA_PIPELINE_DB_URL` environment variable to a valid
starting from that block number.
7. Run the migrations and then run your new script locally and verify it works
as expected.
+8. After all tests pass and you can run the script locally, open a new PR to
+ the monorepo. Don't merge this yet!
+9. If you added any new scripts or dependencies between scripts, you will need
+ to make changes to https://github.com/0xProject/0x-pipeline-orchestration
+ and make a separate PR there. Don't merge this yet!
+10. After your PR passes code review, ask @feuGeneA or @xianny to deploy your
+ changes to the QA environment. Check the [QA Airflow dashboard](http://airflow-qa.0x.org:8080)
+ to make sure everything works correctly in the QA environment.
+11. Merge your PR to 0x-monorepo (and
+ https://github.com/0xProject/0x-pipeline-orchestration if needed). Then ask
+ @feuGeneA or @xianny to deploy to production.
+12. Monitor the [production Airflow dashboard](http://airflow.0x.org:8080) to
+ make sure everything still works.
+13. Celebrate! :tada:
#### Additional guidelines and tips:
@@ -164,3 +178,6 @@ set the`ZEROEX_DATA_PIPELINE_DB_URL` environment variable to a valid
floating point numbers.
* [TypeORM documentation](http://typeorm.io/#/) is pretty robust and can be a
helpful resource.
+* Scripts/parsers should perform minimum data transformation/normalization.
+ The idea here is to have a raw data feed that will be cleaned up and
+ synthesized in a separate step.