Skip to content

Latest commit

 

History

History
164 lines (122 loc) · 13 KB

INTERNAL.md

File metadata and controls

164 lines (122 loc) · 13 KB
Raw

Links for internal team members to find build definitions, etc.

Note that usually only the most recent link in each section is interesting. Older links are included for reference only.

PR Build Definition

The PR build definition can be found here or by navigating through an existing PR.

There is also a duplicate scouting PR build that is identical to the normal PR build except that it uses a different Windows machine queue that always has the next preview build of Visual Studio installed. This is to hopefully get ahead of any breaking API changes. That build definition is here.

Signed Build Definitions

VS 16.4 to current

VS 15.7 to 16.3

VS 15.6

VS 15.0 to 15.5

Branch auto-merge definitions

Branch auto-merge definitions are specified here.

VS Insertion Generators

VS 16.4 to current - part of the build definition. See below.

The following insertion generators are automatically invoked upon successful completion of a signed build in each of their respective branches.

VS 16.3

VS 16.2

VS 16.1

VS 16.0 and prior were done manually.

VS Insertions as part of the build definition

Starting with the 16.4 release and moving forwards, the VS insertion is generated as part of the build. The relevant bits can be found near the bottom of azure-pipelines.yml under the VS Insertion header. The interesting parameters are componentBranchName and insertTargetBranch. In short, when an internal signed build completes and the name of the branch built exactly equals the value in the componentBranchName parameter, a component insertion into VS will be created into the insertTargetBranch branch. The link to the insertion PR will be found near the bottom of the build under the title 'Insert into VS'. Examine the log for 'Insert VS Payload' and near the bottom you'll see a line that looks like Created request #xxxxxx at https://....

Insertions generated to any rel/* branch will have to be manually verified and merged, and they'll be listed here. Note that insertions for other teams will also be listed.

Insertions to any other VS branch (e.g., main) will have the auto-merge flag set and should handle themselves, but it's a good idea to check the previous link for any old or stalled insertions into VS main.

What has to be done regularly

  1. Go to signed builds and make sure latest one for both main and release branches are passing.
  2. Go to insertion PRs and find the latest insertion PR for current release branch. (E.g. Insert F# dev17.13 20241128.1 Payload into main)
  3. Check CI is passing and all comments are resolved.
  4. Check that F# package version is not downgraded (unless that's intended for some reason) by the PR.
  5. Approve it.
  6. Abandon any older unmerged PRs that shouldn't be inserted.

Preparing for a new VS release branch

When a VS branch snaps from main to rel/d* and switches to ask mode:

Update the insertTargetBranch value at the bottom of azure-pipelines.yml in the appropriate release branch. E.g., when VS 17.3 snapped and switched to ask mode, this PR correctly updates the insertion target so that future builds from that F# branch will get auto-inserted to VS.

When VS main is open for insertions for preview releases of VS:

  1. Disable auto-merges from main to current release branch, please make a change for the following file and create a pull request: https://github.com/dotnet/roslyn-tools/blob/6d7c182c46f8319d7922561e2c1586c7aadce19e/src/GitHubCreateMergePRs/config.xml#L52-L74

You should comment out the main -> release/devXX.X flow until step #4 is completed (<merge from="main" to="release/dev17.13" />)

  1. Create a new release/dev* branch (e.g., release/dev17.4) and initially set its HEAD commit to that of the previous release (e.g., release/dev17.3 in this case).

    git checkout -b release/dev17.4
git reset --hard upstream/release/dev17.3
git push --set-upstream upstream release/dev17.4

  2. Update versions in both main and new release branch they need to match, so release notes bot knows which changelog file to check

  3. Update target insertion branches in the azure-pipelines.yml:

    1. F# release branch
    # Release branch for F#
# Should be 'current' release branch name, i.e. 'release/dev17.10' in dotnet/fsharp/refs/heads/main, 'release/dev17.10' in dotnet/fsharp/refs/heads/release/dev17.10 and 'release/dev17.9' in dotnet/fsharp/refs/heads/release/dev17.9
# Should **never** be 'main' in dotnet/fsharp/refs/heads/main, since it will start inserting to VS twice.
- name: FSharpReleaseBranchName
  value: release/dev17.13
    1. VS insertion branch
    # VS Insertion branch name (NOT the same as F# branch)
# Should be previous release branch or 'main' in 'main' and 'main' in release branch
# (since for all *new* release branches we insert into VS main and for all *previous* releases we insert into corresponding VS release),
# i.e. 'rel/d17.9' *or* 'main' in dotnet/fsharp/refs/heads/main and 'main' in F# dotnet/fsharp/refs/heads/release/dev17.10 (latest release branch)
- name: VSInsertionTargetBranchName
  value: main

    [!NOTE] Note
    For the old release branch VSInsertionTargetBranchName should point to corresponding VS release target branch (e.g. should be rel/d17.13 in the F# repo branch release/dev17.13) For both main and new release branch VSInsertionTargetBranchName should be main.

    FSharpReleaseBranchName should always be the most recent in main and corresponding release branch name in release branches.

    1. Oneloc branch:
    # Localization: we only run it for specific release branches
   - ${{ if eq(variables['Build.SourceBranch'], 'refs/heads/release/dev17.13') }}:

  4. Set the new branch to receive auto-merges from main, and also set the old release branch to flow into the new one. This PR is a good example of what to do when a new release/dev17.4 branch is created that should receive merges from both main and the previous release branch, release/dev17.3. Old release branch should stop receiving updates from the main.

  5. Set the packages from the new branch to flow into the correct package feeds via the darc tool. To do this:

    1. To use darc you need to be a member of the dotnetes-maestro-users entitlement. You can request access at coreidentity.microsoft.com
    2. Ensure the latest darc tool is installed by running eng/common/darc-init.ps1.
    3. (only needed once) Run the command darc authenticate. A text file will be opened with instructions on how to populate access tokens.
    4. Check the current package/channel subscriptions by running darc get-default-channels --source-repo fsharp. For this example, notice that the latest subscription shows the F# branch release/dev17.3 is getting added to the VS 17.3 channel.
    5. Get the list of darc channels and determine the appropriate one to use for the new branch via the command darc get-channels. For this example, notice that a channel named VS 17.4 is listed.
    6. Add the new F# branch to the appropriate darc channel. In this example, run darc add-default-channel --channel "VS 17.4" --branch release/dev17.4 --repo https://github.com/dotnet/fsharp
    7. Ensure the subscription was added by repeating step 3 above.
    8. Note, the help in the darc tool is really good. E.g., you can simply run darc to see a list of all commands available, and if you run darc <some-command> with no arguments, you'll be given a list of arguments you can use.
    9. Ensure that version numbers are bumped for a new branch.
    10. Change needed subscriptions for arcade and SDK:
    11. darc get-subscriptions --target-repo fsharp, and then use darc update-subscription --id <subscription id> for corresponding channels (e.g. target new VS channel to specific SDK channel, or set up arcade auto-merges to release/* or main branch, depending on the timeline of release/upgrade cycle).
    12. If new subscription needs to be added, the following command should be used `darc add-subscription --source-repo https://github.com/dotnet/arcade --target-repo https://github.com/dotnet/fsharp --target-branch <target_branch> --channel "<target_channel>" --update-frequency everyDay --standard-automerge
    13. Update mibc and other dependencies if needed, refer to https://github.com/dotnet/arcade/blob/main/Documentation/Darc.md#updating-dependencies-in-your-local-repository for more information

Labeling issues on GitHub

Assign appropriate Area-* label to bugs, feature improvements and feature requests issues alike. List of Area labels with descriptions can be found here. These areas are laid out to follow the logical organization of the code.

To find all existing open issues without assigned Area label, use this query

Since github issue filtering is currently not flexible enough, that query was generated by pasting output of this PowerShell command to the search box (might need to be rerun if new kinds of Area labels are added):

Invoke-WebRequest -Uri "https://api.github.com/repos/dotnet/fsharp/labels?per_page=100" | ConvertFrom-Json | % { $_.name } | ? { $_.StartsWith("Area-") } | % { Write-Host -NoNewLine ('-label:"' + $_ + '" ') }

Fix problems with the internal source mirror

The repo is here, the CI is here.

If something breaks in the CI there and you want to experiment, the general workflow is the following:

  1. Make a branch
  2. Make a change
  3. Run the build from your branch. If needed, set the "skipTests" variable to "true" - can save time at this stage.
  4. Once the problem and the fix is identified, make a PR to THIS (dotnet/fsharp) repo - it will propagate to the internal mirror just afterwards.
  5. Delete all your work in the internal repo.

DO NOT try to push to the internal repo - this will mess up the flows. DO NOT create PRs to not confuse anyone.

You need the following permissions to do the above investigations:

  • "Generic contribute"
  • "Create branch"
  • "Queue builds"
  • "Edit queue build configuration"

If anything, reach out to the "First Responders" team.