Skip to content

Commit 90aa59f

Browse files
reidbakerpiedciphernavaronbracke
authored
Externalize and update onboarding instructions (#154730)
Part 1/n #154724 ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [ ] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing. --------- Co-authored-by: Tirth <[email protected]> Co-authored-by: Navaron Bracke <[email protected]>
1 parent d8f8613 commit 90aa59f

File tree

2 files changed

+67
-25
lines changed

2 files changed

+67
-25
lines changed

dev/conductor/README.md

+5-25
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ Command-line tool for managing a release of the Flutter SDK. Also see
44
[Release Process](../../docs/releases/Release-process.md) for more information on
55
the release process.
66

7-
## Requirements
7+
## Conductor Requirements
88

9-
Some basic requirements to conduct a release are:
9+
Some basic requirements to run conductor are:
1010

1111
- a Linux or macOS computer set up for Flutter development. The conductor does
1212
not support Windows.
1313
- git
14-
- Mirrors on GitHub of the Flutter
14+
- Mirrors on GitHub of the Flutter **
1515
[framework](https://github.com/flutter/flutter) and
1616
[engine](https://github.com/flutter/engine) repositories.
1717

@@ -23,6 +23,8 @@ unlock your ssh key for the session; if you do not, each time the conductor
2323
attempts to interact with a remote, the user will be prompted to enter their ssh
2424
key password.
2525

26+
** Confirm that your personal github clone of flutter/flutter is named flutter and flutter/engine is named engine. If not you will need to use flags to override the defaults.
27+
2628
## Usage
2729

2830
The main entrypoint for the conductor is [bin/conductor](bin/conductor). For
@@ -40,8 +42,6 @@ conductor start \
4042
--candidate-branch=flutter-2.2-candidate.10 \
4143
--release-channel=beta \
4244
--github-username=kingOfDevelopers \
43-
--engine-cherrypicks=72114dafe28c8700f1d5d629c6ae9d34172ba395 \
44-
--framework-cherrypicks=a3e66b396746f6581b2b7efd1b0d0f0074215128,d8d853436206e86f416236b930e97779b143a100 \
4545
--dart-revision=4511eb2a779a612d9d6b2012123575013e0aef12 \
4646
```
4747

@@ -77,26 +77,6 @@ step with the command:
7777

7878
`conductor next`
7979

80-
### Apply Engine Cherrypicks
81-
82-
The tool will attempt to auto-apply all engine cherrypicks. However, any
83-
cherrypicks that result in a merge conflict will be reverted and it is left to
84-
the user to manually cherry-pick them (with the command `git cherry-pick
85-
$REVISION`) and resolve the merge conflict in their checkout.
86-
87-
Once a PR is opened, the user must validate CI builds. If there are regressions
88-
(or if the `licenses_check` fails, then
89-
`//engine/ci/licenses_golden/licenses_third_party` must be updated to match the
90-
output of the failing test), then the user must fix these tests in their local
91-
checkout and push their changes again.
92-
93-
### Apply Framework Cherrypicks
94-
95-
The tool will attempt to auto-apply all framework cherrypicks. However, any
96-
cherrypicks that result in a merge conflict will be reverted and it is left to
97-
the user to manually cherry-pick them (with the command `git cherry-pick
98-
$REVISION`) and resolve the merge conflict in their checkout.
99-
10080
### Publish Version
10181

10282
This step will add a version git tag to the final Framework commit and push it

dev/conductor/RELEASE_ONBOARDING.md

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Release engineer/manager onboarding
2+
3+
Googler facing documentation can be found at go/flutter-release-workflow.
4+
5+
### Responsiblity
6+
7+
Release engineer is responsible for:
8+
* Branch alignment and/or Sheparding cherry picks
9+
* Decision making related to cherry pick risk
10+
* Verification that pre and post submits pass prior to publishing
11+
* Contributor facing communication
12+
* Some public facing post release comunication
13+
14+
In the past (and possibly in the future) there was a distinction between a release engineer and release manager.
15+
For now the responsiblitys are the same and we will refer to the person managing the release as a release engineer.
16+
17+
## Onboarding
18+
One time setup instructions for new or returning relase engineers.
19+
20+
### Groups/Permissions
21+
22+
#### Join flutter-hackers on github
23+
https://github.com/orgs/flutter/teams/flutter-hackers/members
24+
25+
#### [Googler only] Join mdb/flutter-infra
26+
Possibly not required
27+
https://ganpati2.corp.google.com/propose_membership?parent=9147533327&child=$me.prod
28+
29+
#### Join the flutter-announce google group
30+
Ping any current release engineer to add you as an owner and give you publish access.
31+
https://groups.google.com/g/flutter-announce/members?q=role:owner&pli=1
32+
33+
TODO include screenshot
34+
35+
#### [Googler only] Install tool-proxy-client
36+
From a glinux machine run
37+
`sudo apt install tool-proxy-client`
38+
39+
`tool-proxy-client` is the tool that enables/enforces 2 party authorization for controlled builds.
40+
41+
#### [Googler only] Confirm access to release calendar
42+
Public and Beta releases and timelines
43+
go/dash-team-releases
44+
45+
#### [Googler only] Join release chatroom
46+
Release hotline https://chat.google.com/room/AAAA6RKcK2k?cls=7
47+
48+
#### [Googler only] join mdb/flutter-release-team
49+
Controls who can approve 2 party auth requests.
50+
https://ganpati2.corp.google.com/propose_membership?parent=100213927583&child=$me.prod
51+
52+
#### Setup conductor
53+
Conductor is a dart command line interface for common release tasks.
54+
Its instructions are in README.md.
55+
56+
57+
#### [Googler only] Confirm access to Apple signing cert update doc
58+
go/flutter-signing-apple-contracts
59+
Also confirm access to valentine entries listed in that doc.
60+
61+
#### [Googler only] Access release engineer doc
62+
Confirm access to go/release-eng-retros

0 commit comments

Comments
 (0)