Merge pull request #240 from Workiva/2.0.0-dev

CPLAT-4160 v2.0.0 (Dart 2)

Author: rmconsole2-wf

.travis.yml

@@ -1,20 +1,17 @@
 language: dart
-dist: precise
 dart:
-  - "1.24.3"
-env:
-  - DARTIUM_EXPIRATION_TIME="1577836800"
-with_content_shell: true
-before_install:
-  - export DISPLAY=:99.0
-  - ./tool/setup_dartium.sh
-  - export PATH=$PATH":$PWD"
-  - sh -e /etc/init.d/xvfb start
-  - sleep 3 # give xvfb some time to start
+  - stable
 script:
-  - dart ./tool/build.dart
+  - pub run build_runner build --delete-conflicting-outputs
   - pub run dart_dev analyze
-  - pub run dependency_validator --no-fatal-pins -i coverage
-  - pub run dart_dev test --integration
-  - ./tool/generate_coverage.sh
-  - bash <(curl -s https://codecov.io/bash) -f coverage/coverage.lcov
+  # TODO: Remove ignore on analyzer once the wdesk ecosystem is all on a Dart 2 compat major version and we no longer need a "pinned" dep
+  - pub run dependency_validator --no-fatal-pins -i coverage,build_web_compilers,analyzer,build_runner,built_value_generator
+  # run tests on ddc output
+  - pub run build_runner test --delete-conflicting-outputs -- -P dartdevc
+  # run tests on dart2js output
+  - pub run build_runner test -r  --delete-conflicting-outputs -- -P dart2js
+
+cache:
+  directories:
+   - $HOME/.pub-cache
+   - $HOME/.dart_tool/build

CHANGELOG.md

@@ -1,5 +1,41 @@
 # OverReact Changelog
 
+## 2.0.0
+
+> [Complete `2.0.0` Changeset](https://github.com/Workiva/over_react/compare/1.31.0...2.0.0)
+
+This release adds support for Dart 2 while retaining backwards-compatibility
+with Dart 1, **but it requires changes to consumer's component code.**
+
+> Note: If you intend to consume this version of over_react on Dart 1 and Dart 2
+> in the same codebase, **do not** remove the `transformers` section from your
+> `pubspec.yaml`. This section is ignored on Dart 2, but will still be needed on Dart 1
+
+__Breaking Changes__
+
+* In order to add support for Dart 2, consumers need to update their over_react
+    component code! Please see our [Dart 2 migration guide](https://github.com/Workiva/over_react/blob/master/doc/dart2_migration.md)
+    for more information.
+
+    We've created a codemod tool that will automatically update your code:
+
+    ```bash
+    # On Dart 2.1.0
+    $ pub global activate over_react_codemod ^1.0.2
+
+    # If you need backwards-compatibility with Dart 1:
+    $ pub global run over_react_codemod:dart2_upgrade --backwards-compat
+
+    # Or, if you are okay with dropping Dart 1 support:
+    $ pub global run over_react_codemod:dart2_upgrade
+    ```
+
+    The tool (and additional info) can be found here: https://github.com/Workiva/over_react_codemod/
+
+* Removals:
+  * `getJsProps()` - use `getProps()` instead
+  * `$Props` and `$PropKeys` - see the migration guide above
+
 ## 1.31.0
 
 > [Complete `1.31.0` Changeset](https://github.com/Workiva/over_react/compare/1.30.2...1.31.0)

CONTRIBUTING.md

@@ -0,0 +1,73 @@
+# Contributing
+
+> We are working on a more thorough version of these contributing guidlines. For
+> the time being, we've documented our temporary dual-release setup that is
+> necessary for supporting Dart 1 and Dart 2 concurrently.
+
+## Dart 1 & Dart 2 Dual-Releases
+
+Long story short, we are unable to maintain a single codebase of over_react that
+is compatible with both Dart 1 and Dart 2. Transformers only work on Dart 1 and
+builders only work on Dart 2, and we can't maintain the transformer and builder
+together due to dependency conflicts.
+
+> For more information on our Dart 2 migration, [see this guide](/doc/dart2_migration.md).
+
+Fortunately, this problem can be shouldered entirely by the maintainers via a
+dual-release strategy (credit to the [dart2_constant](https://pub.dartlang.org/packages/dart2_constant)
+for the idea). The result is that consumers will depend on a version range of
+this library like they normally do and everything will _just work_.
+
+For every _version_ we want to release, we will actually release two releases -
+a Dart 1 (transformer) version and a Dart 2 (builder) version. These two
+releases will have the same semantic version, but will have unique build
+suffixes. The `pub` client will then decide which one to install based on their
+`environment.sdk` constraints and the active Dart SDK version.
+
+### Branches
+
+- `master`
+  - Dart2-only
+  - Provides a builder
+  - Environment constraint: `>=2.1.0 <3.0.0`
+
+- `master_dart1`
+  - Dart1-only
+  - Provides a transformer
+  - Environment constraint: `>=1.24.3 <2.0.0`
+
+### Release Process
+
+> Note that these steps are intended to be followed by Workiva employees, and as
+> such have some references to internal tooling.
+
+For every release, do the following:
+
+1. Ensure the next release versions exist in MARV:
+
+    Name | Branch
+    ---- | ------
+    over_react 2.x.x-dart1 | master_dart1
+    over_react 2.x.x | master
+
+1. Trigger the `over_react 2.x.x-dart1` release first and review the PR:
+
+   - Ensure the updated `pubspec.yaml` version is correct, including the
+     `-dart1` suffix.
+
+   - Ensure the build passes.
+
+1. Trigger the `over_react 2.x.x` release second and review the PR:
+
+   - Ensure the updated `pubspec.yaml` version is correct.
+
+   - Ensure the build passes.
+
+   - **Add any necessary changelog updates to the Dart 2 version.**
+
+1. **Merge the Dart 1 release first and publish it to pub.**
+
+1. Merge the Dart 2 release second and publish it to pub.
+
+1. Re-recreate the Dart 1 release in MARV (it does not get recreated
+   automatically like the default release does).

Dockerfile

@@ -1,8 +1,20 @@
-FROM google/dart:1.24.3
+FROM google/dart:2.1.0
+
+# Expose env vars for git ssh access
+ARG GIT_SSH_KEY
+ARG KNOWN_HOSTS_CONTENT
+# Install SSH keys for git ssh access
+RUN mkdir /root/.ssh
+RUN echo "$KNOWN_HOSTS_CONTENT" > "/root/.ssh/known_hosts"
+RUN echo "$GIT_SSH_KEY" > "/root/.ssh/id_rsa"
+RUN chmod 700 /root/.ssh/
+RUN chmod 600 /root/.ssh/id_rsa
+RUN echo "Setting up ssh-agent for git-based dependencies"
+RUN eval "$(ssh-agent -s)" && \
+	ssh-add /root/.ssh/id_rsa
 
 WORKDIR /build/
 ADD pubspec.yaml /build
 RUN pub get
 ARG BUILD_ARTIFACTS_AUDIT=/build/pubspec.lock
 FROM scratch
-