Skip to content
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.

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

docs: Start on the Release Process #1319

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

Conversation

ChristianTackeGSI
Copy link
Member

@ChristianTackeGSI ChristianTackeGSI commented Jan 16, 2023

We should be transparent on our release process.

@dennisklein , @karabowi could you please help with this PR? Either add comments or add commits to the branch.

(I'll squash things before we declare this "ready for review".)

Rendered: https://github.com/ChristianTackeGSI/FairRoot/blob/docs-contributing/CONTRIBUTING.md#user-content-creating-a-new-release


Checklist:

Summary by CodeRabbit

  • Documentation
    • Updated CONTRIBUTING.md with detailed instructions for creating a new release, including steps for controlling status, checking CI coverage, creating commits, pushing patches and tags, releasing on GitHub, and merging tags onto the master branch.

@dennisklein
Copy link
Member

dennisklein commented Mar 13, 2023

Hm, how about just a single numbered list instead of heading per step?

Additional steps that come to mind:

  • update CI images, potentially add new ones, remove old ones etc
  • check the ci so everything properly passes

@ChristianTackeGSI
Copy link
Member Author

Hm, how about just a single numbered list instead of heading per step?

Hmm. I don't care much. @karabowi added them in ChristianTackeGSI#1

Additional steps that come to mind:

* update CI images, potentially add new ones, remove old ones etc

Where would you suggest to put this?

* check the ci so everything properly passes

done.

@dennisklein
Copy link
Member

dennisklein commented Mar 15, 2023

Additional steps that come to mind:

  • update CI images, potentially add new ones, remove old ones etc

Where would you suggest to put this?

That is usually, what I do in the context of a release among other things:

  • Remind/ask myself what platforms the release is targeting (I roughly target the last two years of releases for ubuntu/fedora, debian stable/oldstable + anything older, if relevant in GSI still)
  • Then I compare what is currently tested via CI and decide whether it needs an updates, e.g.
    • regenerate/update existing images (cover new FairSoft releases? get latest os updates to test closer to what a user may use)
    • add new images (new os releases? which ship new compiler major versions perhaps)
    • remove old images
    • For macs it involves similar steps, updating homebrew, perhaps the os or the command line tools
  • Fix issues resulting from previous step

@ChristianTackeGSI
Copy link
Member Author

@karabowi as you're currently in the process of creating a new release. Can you take another look at this? Maybe it would be good to merge and improve from there (if it's good enough for a merge)?

If you want to take a look how the proposed changes look like when rendered: https://github.com/ChristianTackeGSI/FairRoot/blob/docs-contributing/CONTRIBUTING.md#user-content-creating-a-new-release

Copy link

coderabbitai bot commented May 23, 2024

Walkthrough

Walkthrough

The CONTRIBUTING.md file has been updated to include comprehensive instructions for creating a new release. This addition covers essential steps such as controlling status, checking CI coverage, creating a commit, pushing patches and tags, releasing on GitHub, and merging tags onto the master branch. No changes were made to the declarations of exported or public entities.

Changes

File Change Summary
CONTRIBUTING.md Added detailed instructions for creating a new release, including steps for status control, CI checks, commits, pushing patches and tags, GitHub releases, and merging tags onto the master branch.

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 6eaf8b4 and a0f4847.
Files selected for processing (1)
  • CONTRIBUTING.md (2 hunks)
Additional Context Used
LanguageTool (8)
CONTRIBUTING.md (8)

Near line 16: A punctuation mark might be missing here.
Context: ... your PR which adds your name to the CONTRIBUTORS file. 3. Fo...
Rule ID: AI_EN_LECTOR_MISSING_PUNCTUATION


Near line 24: This phrase is redundant. Consider writing “at this point”, “at this time”, or “now”.
Context: ...hese guidelines are horribly incomplete at this point in time, but one has to start somewhere ;) Exac...
Rule ID: AT_THIS_POINT_IN_TIME


Near line 45: This phrase is redundant. Consider writing “evolve”.
Context: ...arnings. The set of enabled checks will evolve over time. ### G.2 Adopted C++ Core Guidelines ...
Rule ID: EVOLVE_OVER_TIME


Near line 65: Probable usage error. Use “and” after ‘both’.
Context: ...a-keyword) both in commit messages as well as in PR comments if applicable. ## D - D...
Rule ID: BOTH_AS_WELL_AS


Near line 76: The adverb ‘Rarely’ is usually not used at the beginning of a sentence if a subject pronoun comes after it.
Context: ...ig**: .clang-format Rarely, it is needed to opt-out of *clang-form...
Rule ID: ADVERB_WORD_ORDER


Near line 77: The word “opt-out” is a noun. The verb is spelled with a space.
Context: ....clang-format) Rarely, it is needed to opt-out of clang-format for certain code sect...
Rule ID: NOUN_VERB_CONFUSION


Near line 129: Consider adding a comma.
Context: ...nything older, if relevant in GSI still) * Then I compare what is currently tested via ...
Rule ID: IF_THEN_COMMA


Near line 180: A comma might be missing here.
Context: ...a new release on GitHub. ## In certain cases the tag should be merged onto master: ...
Rule ID: AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA

Markdownlint (18)
CONTRIBUTING.md (18)

53: Expected: 2; Actual: 3
Unordered list indentation


57: Expected: 0; Actual: 3
Unordered list indentation


58: Expected: 0; Actual: 3
Unordered list indentation


61: Expected: 0; Actual: 3
Unordered list indentation


64: Expected: 0; Actual: 3
Unordered list indentation


132: Expected: 2; Actual: 3
Unordered list indentation


134: Expected: 2; Actual: 3
Unordered list indentation


136: Expected: 2; Actual: 3
Unordered list indentation


137: Expected: 2; Actual: 3
Unordered list indentation


111: Expected: 1; Actual: 2
Multiple consecutive blank lines


56: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


22: null
Multiple top-level headings in the same document


112: null
Multiple top-level headings in the same document


31: null
Fenced code blocks should be surrounded by blank lines


81: null
Fenced code blocks should be surrounded by blank lines


101: null
Fenced code blocks should be surrounded by blank lines


57: null
Lists should be surrounded by blank lines


31: null
Fenced code blocks should have a language specified

Additional comments not posted (5)
CONTRIBUTING.md (5)

15-15: Consider adding a comma after "contributor" for better readability.


129-129: Consider adding a comma after "still" for better readability.


180-180: Consider adding a comma after "GitHub" for better readability.


111-111: Remove extra blank lines to maintain a clean and consistent document structure.


Line range hint 31-31: Specify the language for code blocks to enhance syntax highlighting.

Also applies to: 81-81, 101-101


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to full the review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 4

Outside diff range and nitpick comments (7)
CONTRIBUTING.md (7)

Line range hint 15-15: Consider using "first-time" instead of "first time" for grammatical correctness.


Line range hint 24-24: Simplify "at this point in time" to "now" for conciseness.


Line range hint 45-45: The phrase "will evolve over time" can be simplified to "will evolve" for conciseness.


Line range hint 65-65: Use "and" after 'both' to correct the usage error in "both in commit messages as well as in PR comments".

- both in commit messages as well as in PR comments if applicable.
+ both in commit messages and in PR comments if applicable.

Line range hint 76-77: Move "Rarely" to a position after the subject for better readability and correct the verb form of "opt-out".

- Rarely, it is needed to opt-out of *clang-format* for certain code sections
+ It is rarely needed to opt out of *clang-format* for certain code sections

Line range hint 53-64: Correct the indentation of unordered list items to maintain consistency.

-   * regenerate/update existing images (cover new FairSoft releases? get
-     latest os updates to test closer to what a user may use)
-   * add new images (new os releases? which ship new compiler major versions
-     perhaps)
-   * remove old images
-   * For macs it involves similar steps, updating homebrew, perhaps the os
-     or the command line tools
+ * regenerate/update existing images (cover new FairSoft releases? get
+   latest os updates to test closer to what a user may use)
+ * add new images (new os releases? which ship new compiler major versions
+   perhaps)
+ * remove old images
+ * For macs it involves similar steps, updating homebrew, perhaps the os
+   or the command line tools

Line range hint 56-56: Ensure headings are surrounded by blank lines for better readability and consistency.

+ 
# Creating a new Release
+ 

CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Outside diff range and nitpick comments (2)
CONTRIBUTING.md (2)

Line range hint 24-24: Consider simplifying the phrase "at this point in time" to "currently" for conciseness.


Line range hint 53-64: Adjust the indentation of the unordered list items to match the expected levels.

-   * regenerate/update existing images (cover new FairSoft releases? get
-     latest os updates to test closer to what a user may use)
-   * add new images (new os releases? which ship new compiler major versions
-     perhaps)
-   * remove old images
-   * For macs it involves similar steps, updating homebrew, perhaps the os
-     or the command line tools
+ * regenerate/update existing images (cover new FairSoft releases? get
+   latest os updates to test closer to what a user may use)
+ * add new images (new os releases? which ship new compiler major versions
+   perhaps)
+ * remove old images
+ * For macs it involves similar steps, updating homebrew, perhaps the os
+   or the command line tools

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

Outside diff range and nitpick comments (6)
CONTRIBUTING.md (6)

Line range hint 24-24: Simplify the phrase for clarity.

- These guidelines are horribly incomplete at this point in time, but one has to start somewhere ;)
+ These guidelines are still in development, but one has to start somewhere ;)

Line range hint 45-45: Remove redundancy in the phrase.

- The set of enabled checks will evolve over time.
+ The set of enabled checks will evolve.

Line range hint 65-65: Correct the grammatical structure for clarity.

- both in commit messages as well as in PR comments if applicable.
+ both in commit messages and in PR comments if applicable.

Line range hint 76-77: Correct the verb form for "opt-out".

- Rarely, it is needed to opt-out of *clang-format* for certain code sections
+ Rarely, it is needed to opt out of *clang-format* for certain code sections

Line range hint 53-53: Standardize unordered list indentation.

-  * regenerate/update existing images (cover new FairSoft releases? get
-    latest os updates to test closer to what a user may use)
-  * add new images (new os releases? which ship new compiler major versions
-    perhaps)
-  * remove old images
-  * For macs it involves similar steps, updating homebrew, perhaps the os
-    or the command line tools
+ * regenerate/update existing images (cover new FairSoft releases? get
+   latest os updates to test closer to what a user may use)
+ * add new images (new os releases? which ship new compiler major versions
+   perhaps)
+ * remove old images
+ * For macs it involves similar steps, updating homebrew, perhaps the os
+   or the command line tools

Also applies to: 57-57, 58-58, 61-61, 64-64, 132-132, 134-134, 136-136, 137-137


Line range hint 56-56: Ensure headings are surrounded by blank lines for better readability.

+ 
# Creating a new Release
+ 

CONTRIBUTING.md Show resolved Hide resolved
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 5

Outside diff range and nitpick comments (4)
CONTRIBUTING.md (4)

Line range hint 24-24: Simplify the phrase for clarity.

- These guidelines are horribly incomplete at this point in time, but one has to start somewhere ;)
+ These guidelines are still incomplete, but one has to start somewhere ;)

Line range hint 45-45: Remove redundancy in the phrase.

- The set of enabled checks will evolve over time.
+ The set of enabled checks will evolve.

Line range hint 65-65: Correct the conjunction usage for grammatical accuracy.

- both in commit messages as well as in PR comments if applicable.
+ both in commit messages and in PR comments if applicable.

Line range hint 76-77: Correct the verb form for "opt-out".

- Rarely, it is needed to opt-out of *clang-format* for certain code sections
+ Rarely, it is needed to opt out of *clang-format* for certain code sections

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
ChristianTackeGSI and others added 2 commits May 28, 2024 10:07
We should be transparent about our release process.

Co-Authored: @karabowi
Co-Authored: @dennisklein
Added section about complicated patch branch merging process.
Added section about major version.
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range and nitpick comments (7)
CONTRIBUTING.md (7)

Line range hint 24-24: Consider simplifying "at this point in time" to "currently" to enhance clarity.

- These guidelines are horribly incomplete at this point in time, but one has to start somewhere ;)
+ These guidelines are horribly incomplete currently, but one has to start somewhere ;)

Line range hint 45-45: The phrase "will evolve over time" can be simplified to "will evolve".

- The set of enabled checks will evolve over time.
+ The set of enabled checks will evolve.

Line range hint 65-65: Clarify the usage of "both" by adding "and".

- both in commit messages as well as in PR comments if applicable.
+ both in commit messages and in PR comments if applicable.

Line range hint 76-77: Correct the verb form for "opt-out".

- Rarely, it is needed to opt-out of *clang-format* for certain code sections
+ Rarely, it is needed to opt out of *clang-format* for certain code sections

Line range hint 56-56: Ensure that headings are surrounded by blank lines for proper Markdown formatting.

- # Creating a new Release
+ 
+ # Creating a new Release
+ 

Line range hint 31-31: Ensure that fenced code blocks are surrounded by blank lines for proper Markdown formatting.

- ```
+ 
+ ```
+ 

Also applies to: 81-81, 101-101


Line range hint 57-57: Ensure that lists are surrounded by blank lines for proper Markdown formatting.

- * Then I compare what is currently tested via CI and decide whether it
+ 
+ * Then I compare what is currently tested via CI and decide whether it
+ 

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants