Adding locally-maintained Checked-C-specific documents.#1190
Merged
Conversation
mattmccutchen-cci
left a comment
mattmccutchen-cci
left a comment
Member
There was a problem hiding this comment.
Thanks for making sure these documents remain available. I looked over the ones I thought I might know something about, and I have one substantive correction and a few typo fixes.
|
|
||
| 7. The last step is to merge PR 123 into the `master` branch of our remote repository (https://github.com/microsoft/checkedc-clang). Two points should be kept in mind: | ||
|
|
||
| 1. The merge should either be a `merge commit` or a `squash merge` depending on the context of the PR. For example, PRs from CCI should always be `merge commit` as CCI needs to be able to access the commit history in their PRs. |
Member
There was a problem hiding this comment.
Suggested change
| 1. The merge should either be a `merge commit` or a `squash merge` depending on the context of the PR. For example, PRs from CCI should always be `merge commit` as CCI needs to be able to access the commit history in their PRs. | |
| 1. The merge should either be a "merge commit" or a "squash merge" depending on the context of the PR. For example, "omnibus" 3C PRs from CCI ([example](https://github.com/microsoft/checkedc-clang/pull/1065)) should always be "merge commit" because they contain intermediate commits from CCI's `main` branch that need to stay in sync between CCI's and Microsoft's repositories after the merge. But for most PRs, the intermediate commits just reflect steps of work and code review that don't need to stay in sync with anywhere else, so a "squash merge" leaves a simpler history on the `master` branch for the benefit of most readers. Readers who want more detail can still access the intermediate commits on the PR page or via the `pull/123/head` ref described above (which still exists after the PR is merged). |
Clarifying that "merge commit" is needed only for omnibus 3C PRs (such as #1065), not other PRs that happen to come from CCI but follow essentially the same workflow as internal PRs (such as #1112). Feel free to improve the text further.
|
|
||
| 7. Update the release notes for the current release in this draft, guided by previous release notes. Also upload the release artifacts. Some points to note: | ||
|
|
||
| - The release note should mention the version of the Checked C language specification that the released compiler is based on as this version number if not available in the name or tag associated with the release. |
Member
There was a problem hiding this comment.
Suggested change
| - The release note should mention the version of the Checked C language specification that the released compiler is based on as this version number if not available in the name or tag associated with the release. | |
| - The release note should mention the version of the Checked C language specification that the released compiler is based on as this version number is not available in the name or tag associated with the release. |
|
|
||
| 9. Similar to the release made in the `checkedc-clang` repository, a release has to be made in the `checkedc` repository also. The only artifact in this release is the Checked C specification. It should be the same as the one released through the `checkedc-clang` release (i.e. both the releases must be in sync). The same tag as in step 3 must be applied to the `master` branch of the `checkedc` repository. | ||
|
|
||
| 10. Apply an annotation tag (same tag as in step 3) on the `master` branches of both `checkedc-automation` and `checkedc-llvm-test-suite` repositories using the command below (assumes that the `master` branch of both these repositories is checked out and it is at exactly the same revision that was used to test the release): |
Member
There was a problem hiding this comment.
Suggested change
| 10. Apply an annotation tag (same tag as in step 3) on the `master` branches of both `checkedc-automation` and `checkedc-llvm-test-suite` repositories using the command below (assumes that the `master` branch of both these repositories is checked out and it is at exactly the same revision that was used to test the release): | |
| 10. Apply an annotated tag (same tag as in step 3) on the `master` branches of both `checkedc-automation` and `checkedc-llvm-test-suite` repositories using the command below (assumes that the `master` branch of both these repositories is checked out and it is at exactly the same revision that was used to test the release): |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.