docs(release): Update the release doc for the new process

soulcramer commented 3 months ago

📋 Changes

Add a new section in the RELEASING doc with a new styleguide for CHANGELOG entries.

🤔 Context

Close #1158

✅ Checklist

[x] I have reviewed the submitted code.

🗒️ Other info

Next steps would be to create some sort of guide lines for components creations on what we expect fro ma full component (like examples, configurator, good api, clear documentation, backward compatibility)

Summary by CodeRabbit

Documentation
- Introduced a structured process for pre-release and release activities in the RELEASING.md file, including steps for draft releases, version updates, changelogs, and artifact promotion.
- Added a new CHANGELOG STYLE GUIDE.md providing detailed guidelines for creating consistent and clear changelogs.

github-actions[bot] commented 3 months ago

Job Summary for Gradle

👷 Build → 🧑‍🔬 Test → 🕵️ Lint :: validation

Gradle Root Project	Requested Tasks	Gradle Version	Build Outcome	Build Scan®
spark-android	dependencyGuard	8.8	:white_check_mark:
spark-android	spotlessCheck :build-logic:spotlessCheck	8.8	:x:

coderabbitai[bot] commented 3 months ago

Walkthrough

The changes introduce structured processes for pre-release and release activities, including detailed steps for drafting, testing, and publishing releases on GitHub, updating version information, and managing changelogs. Additionally, a new style guide for creating consistent changelogs has been added. These updates aim to streamline release management and ensure clarity and consistency in project documentation.

Changes

Files/Paths	Change Summary
`RELEASING.md`	Added structured processes for pre-release and release activities, including creating draft releases, updating version info, managing changelogs, and promoting artifacts.
`docs/CHANGELOG STYLE GUIDE.md`	Introduced a detailed style guide for creating changelogs, covering version headers, date formats, section headers, change types, and formatting guidelines.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHub
    participant Sonatype Nexus
    participant Users

    Developer->>GitHub: Create Draft Release
    Developer->>GitHub: Generate Release Notes
    Developer->>GitHub: Format Logs and Set Pre-release Flag

    note left of Developer: Testing and Bug Reporting Period

    Users->>Developer: Feedback Submission

    Developer->>GitHub: Update Version in gradle.properties
    Developer->>GitHub: Update CHANGELOG.md
    Developer->>GitHub: Push Changes

    Developer->>Sonatype Nexus: Promote Artifacts
    Developer->>GitHub: Trigger Dokka Workflow

    Developer->>GitHub: Draft and Publish New Release
    GitHub->>Users: Notify on New Release

    note right of Developer: Process Complete

Poem

On GitHub's stage we draft and cheer,
Testing, fixing, feedback we steer.
Changelogs polished, Dokka in stride,
Artifacts soar, in Nexus they glide.
🎉 A release well-done, we celebrate,
With code so fine, our future we elate! 🚀

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 do a full 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

adevinta / spark-android