Skip to content

Add guide for updating the clang-format version #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Add guide for updating the clang-format version #14

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2daff5e
Add guide for updating the clang-format version
Feb 12, 2019
84bb4fd
Update README.md
Feb 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,3 +95,30 @@ git clone --branch <TODO: version> https://github.com/material-foundation/clang-
--target_branch "$KOKORO_GITHUB_PULL_REQUEST_TARGET_BRANCH"
```

## How to update the clang-format-ci version

First: build and release the clang-format version.

1. Fork and clone https://github.com/material-foundation/clang-format onto a mac machine.
2. Run `clang-format --version` to identify your local version of clang-format.
3. Edit the [`REV`](https://github.com/material-foundation/clang-format/blob/develop/build.sh#L20) variable in `build.sh` with the revision number you'd like to build.
4. Run `build.sh`.
5. While the build is running, create a pull request with the changes to build.sh.
6. Get the pull request reviewed and merged in to `develop`.
7. Once the local build has finished (takes 1hr+), create a draft release named after the clang-format revision number.
8. Upload the clang-format binary to the release.
9. Include the generated SHA value in the release notes.
10. Publish the release.

Second: create a new clang-format-ci release.

1. Fork and clone https://github.com/material-foundation/clang-format-ci onto a mac machine.
2. Edit the `CLANG_FORMAT_TAG` and `CLANG_FORMAT_SHA` values in [`from-kokoro.sh`](https://github.com/material-foundation/clang-format-ci/blob/develop/from-kokoro.sh#L22-L29) with the tag and sha from the steps above.
3. Send the changes out as a PR.
4. Get the pull request reviewed and merged in to `develop`.
5. Install the [`mdm` toolchain](https://github.com/material-motion/tools#installation). You'll use this to cut the release on clang-format.
Copy link
Contributor

@fluxminds fluxminds Feb 19, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure if we should document the alternative process when mdm install failed? Like copying some git workflows from the mdm script?

6. Cut the release by running `mdm release cut`.
7. Update the changelog notes.
8. Push the release-candidate to GitHub and open an PR for review to stable.
9. Once the PR is LGTM'd, do not merge it via GitHub. Instead, run `mdm release merge <#version number#>`.
11. Run `mdm release publish` to publish the release.