diff --git a/.github/workflows/sync.yml b/.github/workflows/sync.yml new file mode 100644 index 0000000000000000000000000000000000000000..d85fb86807e3341de7dc49591ad0731afd66bd74 --- /dev/null +++ b/.github/workflows/sync.yml @@ -0,0 +1,34 @@ +# YAML schema for GitHub Actions: +# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions +# +# Helpful YAML parser to clarify YAML syntax: +# https://yaml-online-parser.appspot.com/ +# + +name: Sync from Upstream TF + +on: + schedule: + - cron: '0 8 * * *' + + # Allow manually triggering of the workflow. + workflow_dispatch: {} + +jobs: + sync: + runs-on: ubuntu-latest + steps: + - uses: actions/setup-python@v2 + - uses: actions/checkout@v2 + - name: Create TFLM tree + run: | + ./ci/sync_from_upstream_tf.sh + - name: Create Pull Request + uses: peter-evans/create-pull-request@052fc72b4198ba9fbc81b818c6e1859f747d49a8 + with: + branch: sync-from-upstream-tf + delete-branch: true + title: Automated sync from github.com/tensorflow/tensorflow + commit-message: Automated sync from github.com/tensorflow/tensorflow + body: "" + labels: ci:run diff --git a/README.md b/README.md index e4be0c817fc80ee88b57b98a80c8221052e1caa1..0857bdd291a38fac3ecc3b578e60996040bffda1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,14 @@ + + * [TensorFlow Lite for Microcontrollers](#tensorflow-lite-for-microcontrollers) + * [Build Status](#build-status) + * [Official Builds](#official-builds) + * [Community Supported Builds](#community-supported-builds) + * [Additional Documentation](#additional-documentation) + + + + + # TensorFlow Lite for Microcontrollers The TFLM code is currently in the process of being refactored out of the @@ -22,3 +33,7 @@ Arduino | [![Arduino](https://github.com/tensorflow/tflite-micro/actions Cortex-M | [![Cortex-M](https://github.com/tensorflow/tflite-micro/actions/workflows/cortex_m.yml/badge.svg)](https://github.com/tensorflow/tflite-micro/actions/workflows/cortex_m.yml) | Sparkfun Edge | [![Sparkfun Edge](https://github.com/tensorflow/tflite-micro/actions/workflows/sparkfun_edge.yml/badge.svg)](https://github.com/tensorflow/tflite-micro/actions/workflows/sparkfun_edge.yml) | + +# Additional Documentation + + * [Continuous Integration](docs/continuous_integration.md) diff --git a/docs/continuous_integration.md b/docs/continuous_integration.md new file mode 100644 index 0000000000000000000000000000000000000000..f56717e584741a4f6688d5babb16ed8313621cee --- /dev/null +++ b/docs/continuous_integration.md @@ -0,0 +1,28 @@ + + * [Automated Sync from the Tensorflow Repository](#automated-sync-from-the-tensorflow-repository) + * [Third Party GitHub Actions Used](#third-party-github-actions-used) + + + + + +[TensorFlow repo]: https://github.com/tensorflow/tensorflow + +# Automated Sync from the Tensorflow Repository + +While TfLite Micro and TfLite are in separate GitHub repositories, the two +projects continue to share common code. + +The [TensorFlow repo][] is the single source of truth for this +shared code. As a result, any changes to this shared code must be made in the +[TensorFlow repo][] which will then automatically sync'd via a scheduled +[GitHub workflow](../.github/workflows/sync.yml). + + +# Third Party GitHub Actions +We use the following third party actions as part of the TFLM continuous +integration system. + + * [Create a PR](https://github.com/peter-evans/create-pull-request) to automate + sync'ing of shared TfLite and TFLM code. +