Skip to content

Commit c6ba914

Browse files
authored
Update README.md with instructions on how to update androidx/androidx (#58)
1 parent 74fb882 commit c6ba914

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,42 @@ Each time a tag is pushed for `latest` or `v*`; a distrubtion build is
1010
prepared in CI that will be pushed at `dist-<tagname>` tag.
1111
See `dist.yml` build action for details.
1212

13+
```
14+
git tag -a v0.11 -m "my changes"
15+
git push origin v0.11 # will trigger a release build
16+
```
17+
Updating the dist-latest:
18+
```
19+
git tag -a -f latest -m "my changes"
20+
git push origin latest -f # need to force to override the tag
21+
```
22+
23+
24+
## Updating AndroidX
25+
[AndroidX](https://github.com/androidx/androidx) uses `dist-latest` versions of
26+
this project to run tests. As a result, changes here are not reflected until
27+
a new `latest` release is made. ([ci config file](https://github.com/androidx/androidx/blob/androidx-main/.github/workflows/integration_tests.yml))
28+
29+
AndroidX also runs the action from the main branch to be able to access firebase keys.
30+
That means, even if you send a PR that changes the config file, its changes will not
31+
impact your PR since your changes won't be on the main branch.
32+
33+
If you need to itereate on the changes across two repositories, do the following:
34+
35+
* Create your branch on the androidx/androidx repository (needed to access FTL keys).
36+
* Create a new build file that looks like [this one](https://github.com/androidx/androidx/blob/yigit/update-ci-action/.github/workflows/integration_tests_manual.yml).
37+
* Update the `target-run-id` with a run id from one of the successful
38+
[presubmit runs](https://github.com/androidx/androidx/actions/workflows/presubmit.yml). You can find
39+
the `target-run-id` in the URL when you navigate to the run page.
40+
* Update the `run_tests` step to reference your branch on the androidx-ci-action. Note that,
41+
this does not require you to make a release build as we still have an `action.yml` file that will
42+
compile and run the action.
43+
* Once you are happy with your changes in androidx-ci-action, send a PR in `androidx-ci-action`
44+
and take a `latest` release after it is merged.
45+
* Discard your branch on androidx/androidx.
46+
47+
48+
1349
Copyright:
1450

1551
Copyright 2020 Google LLC
@@ -24,4 +60,4 @@ Copyright:
2460
distributed under the License is distributed on an "AS IS" BASIS,
2561
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
2662
See the License for the specific language governing permissions and
27-
limitations under the License.
63+
limitations under the License.

0 commit comments

Comments
 (0)