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

Update release publishing guide and move it to an issue template (Lombiq Technologies: OCORE-163) #15830

Merged
merged 18 commits into from
May 2, 2024

Conversation

Piedone
Copy link
Member

@Piedone Piedone commented Apr 25, 2024

Related to #15824. I updated the release publishing guide with what we actually do, and optimized it a bit. I also moved it to an issue template, since having to always copy it to an issue is unnecessary.

Reviewers: if you want to see what I changed in the guide before moving it to the issue template, see the diff here.

Summary by CodeRabbit

  • Documentation
    • Updated the GitHub issue template for publishing Orchard Core releases.
    • Streamlined the release process documentation to guide users through a GitHub issue checklist.

Copy link
Contributor

coderabbitai bot commented Apr 25, 2024

Walkthrough

The new file .github/ISSUE_TEMPLATE/release.md introduces a comprehensive template for orchestrating Orchard Core releases. This template guides users through the steps involved in preparing, testing, releasing, and promoting a new version, along with post-release activities, ensuring a systematic approach to the release process.

Changes

File Path Change Summary
.github/ISSUE_TEMPLATE/release.md New template for managing Orchard Core releases, covering project preparation, code and documentation updates, testing, translation adjustments, publishing, promotion, and post-release tasks.

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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
Contributor

@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

src/docs/topics/publishing-releases/README.md Outdated Show resolved Hide resolved
src/docs/topics/publishing-releases/README.md Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release.md Show resolved Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Contributor

@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

.github/ISSUE_TEMPLATE/release.md Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release.md Outdated Show resolved Hide resolved
Copy link
Contributor

@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

.github/ISSUE_TEMPLATE/release.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release.md Show resolved Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Member

@MikeAlhayek MikeAlhayek left a comment

Choose a reason for hiding this comment

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

LGTM

.github/ISSUE_TEMPLATE/release.md Outdated Show resolved Hide resolved
Piedone and others added 2 commits May 1, 2024 22:59
@Piedone Piedone requested a review from MikeAlhayek May 1, 2024 21:00
@Piedone
Copy link
Member Author

Piedone commented May 1, 2024

Modified it a bit from #15938.

Copy link
Contributor

@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

.github/ISSUE_TEMPLATE/release.md Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release.md Outdated Show resolved Hide resolved
Copy link
Contributor

@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

.github/ISSUE_TEMPLATE/release.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release.md Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release.md Show resolved Hide resolved
Piedone and others added 2 commits May 2, 2024 00:15
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@Piedone
Copy link
Member Author

Piedone commented May 1, 2024

@coderabbitai pause

Copy link
Contributor

@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

.github/ISSUE_TEMPLATE/release.md Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release.md Show resolved Hide resolved
@Piedone
Copy link
Member Author

Piedone commented May 1, 2024

@coderabbitai stop

Copy link
Contributor

coderabbitai bot commented May 1, 2024

@Piedone, I've paused the automated reviews for this PR as requested. If you need further assistance or wish to resume reviews, just let me know!

Actions performed

Reviews paused.

Copy link
Contributor

@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: 8

.github/ISSUE_TEMPLATE/release.md Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release.md Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release.md Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release.md Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release.md Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release.md Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release.md Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release.md Show resolved Hide resolved
Copy link
Contributor

github-actions bot commented May 2, 2024

This pull request has merge conflicts. Please resolve those before requesting a review.

# Conflicts:
#	src/docs/topics/publishing-releases/README.md
@Piedone Piedone merged commit 7e54252 into OrchardCMS:main May 2, 2024
6 checks passed
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.

2 participants