FairRoot icon indicating copy to clipboard operation
FairRoot copied to clipboard

Published 20 hours ago • verified publisher icon FairRootGroup

docs: Start on the Release Process

Open ChristianTackeGSI opened this issue 2 years ago • 6 comments

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:

ChristianTackeGSI avatar Jan 16 '23 16:01 ChristianTackeGSI

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

dennisklein avatar Mar 13 '23 19:03 dennisklein

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

Hmm. I don't care much. @karabowi added them in https://github.com/ChristianTackeGSI/FairRoot/pull/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.

ChristianTackeGSI avatar Mar 13 '23 20:03 ChristianTackeGSI

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

dennisklein avatar Mar 15 '23 17:03 dennisklein

Added text by @dennisklein

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

ChristianTackeGSI avatar Mar 30 '23 07:03 ChristianTackeGSI

@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

ChristianTackeGSI avatar Apr 01 '24 19:04 ChristianTackeGSI

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 6eaf8b4f15be30ee053a730b57cdd864ecda70b6 and a0f48472676c96b3a142a027efa0c616ba8119c5.
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.

coderabbitai[bot] avatar May 23 '24 22:05 coderabbitai[bot]