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

PR1: Add release notes and changelogs to the sleap.ai website #1500

Open
wants to merge 17 commits into
base: develop
Choose a base branch
from

Conversation

shrivaths16
Copy link
Contributor

@shrivaths16 shrivaths16 commented Sep 14, 2023

Description

Add bulletin.md file to the docs folder and update the index.rst appropriately with the bulletin file to be displayed on the sleap.ai website.

This is the first of the four PRs that are needed to complete this discussion #1492.

Types of changes

  • Bugfix
  • New feature
  • Refactor / Code style update (no logical changes)
  • Build / CI changes
  • Documentation Update
  • Other (explain)

Does this address any currently open issues?

Outside contributors checklist

  • Review the guidelines for contributing to this repository
  • Read and sign the CLA and add yourself to the authors list
  • Make sure you are making a pull request against the develop branch (not main). Also you should start your branch off develop
  • Add tests that prove your fix is effective or that your feature works
  • Add necessary documentation (if appropriate)

Thank you for contributing to SLEAP!

❤️

Summary by CodeRabbit

  • Documentation
    • Updated the workflow to include changes in the documentation and README.
    • Released bulletin with release notes for SLEAP version 1.3.3, covering new changes, fixes, and dependency updates.
    • Added a "What's new" section in the documentation for easier access to the latest updates.

@shrivaths16 shrivaths16 changed the title Add release notes and changelogs to the sleap.ai website PR1: Add release notes and changelogs to the sleap.ai website Sep 19, 2023
@shrivaths16 shrivaths16 marked this pull request as ready for review September 28, 2023 16:25
@coderabbitai
Copy link

coderabbitai bot commented Sep 28, 2023

Walkthrough

A new workflow branch for SLEAP documentation updates has been introduced, and the SLEAP documentation itself has been enhanced with release notes for version 1.3.3 and a new navigation link for users to quickly find what's new.

Changes

File Path Change Summary
.github/workflows/.../website.yml Added "shrivaths/changelog-announcement-1" branch trigger for workflow
docs/bulletin.md Documented release notes for SLEAP v1.3.3
docs/index.rst Added "What's new" link to navigation

🐇✨
In the burrows of code, a new path does wind,
A changelog grows, with version outlined.
Click "What's new", for updates you'll find,
A SLEAP forward, for machine learning refined.
🌟📜

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 with CodeRabbit Bot (@coderabbitai)

  • You can directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • You can tag CodeRabbit on specific lines of code or entire files in the PR by tagging @coderabbitai in a comment. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • You can tag @coderabbitai in a PR comment and ask questions about the PR and the codebase. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid.
    • @coderabbitai read the files in the src/scheduler package and generate 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.

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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@shrivaths16 shrivaths16 requested review from roomrys and removed request for talmo September 28, 2023 16:25
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.

Review Status

Actionable comments generated: 0

Commits Files that changed from the base of the PR and between cdf8cba and 8ab2e6c.
Files selected for processing (3)
  • .github/workflows/website.yml (1 hunks)
  • docs/bulletin.md (1 hunks)
  • docs/index.rst (1 hunks)
Files skipped from review due to trivial changes (2)
  • .github/workflows/website.yml
  • docs/index.rst
Additional comments (Suppressed): 1
docs/bulletin.md (1)
  • 1-74: The bulletin.md file is well-structured and provides a comprehensive overview of the changes in SLEAP v1.3.2. It includes installation instructions, highlights of the new features, a full changelog, and acknowledgements to contributors. The links to the pull requests provide transparency and traceability for each change. This is a good practice as it allows users to easily find more detailed information about each change.

Copy link
Collaborator

@roomrys roomrys left a comment

Choose a reason for hiding this comment

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

Small non-functional changes requested.

.github/workflows/website.yml Outdated Show resolved Hide resolved
docs/bulletin.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.

Review Status

Actionable comments generated: 0

Commits Files that changed from the base of the PR and between 8ab2e6c and e520176.
Files selected for processing (1)
  • docs/bulletin.md (1 hunks)
Additional comments (Suppressed): 1
docs/bulletin.md (1)
  • 1-77: The new hunk for docs/bulletin.md provides a comprehensive overview of the changes introduced in SLEAP v1.3.2. It includes installation instructions, highlights of the new features, a full changelog detailing enhancements and fixes, updates on dependencies, and acknowledgment of new contributors. The links to the pull requests provide transparency and traceability for each change. This is a well-structured and informative bulletin.

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.

Review Status

Actionable comments generated: 0

Commits Files that changed from the base of the PR and between e520176 and c0ea01d.
Files selected for processing (1)
  • .github/workflows/website.yml (1 hunks)
Files skipped from review due to trivial changes (1)
  • .github/workflows/website.yml

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.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between c0ea01d and 9e0e1c4.
Files selected for processing (2)
  • docs/bulletin.md (1 hunks)
  • docs/index.rst (1 hunks)
Additional comments: 5
docs/bulletin.md (4)
  • 1-7: The introduction of the release notes for SLEAP v1.3.3 is clear and concise. The explanation of the brown-bag release and the issues it addresses is well-documented.

  • 9-21: The installation instructions and reminders for SLEAP v1.3.3 are detailed and provide clear guidance for users. However, ensure that the installation commands are tested and verified to work as expected.

  • 23-50: The quick install commands and the full changelog link for SLEAP v1.3.3 are well-placed and formatted. It's important to ensure that the provided URLs and commands are accurate and functional.

  • 58-128: The release notes for SLEAP v1.3.2 are comprehensive, including highlights, enhancements, fixes, dependencies, and new contributors. Ensure that all links are correct and that the contributions are accurately attributed.

docs/index.rst (1)
  • 20-20: The addition of the "What's new" link to the table of contents in index.rst is correctly formatted and will help users find the latest information on SLEAP updates.

docs/bulletin.md Outdated
Comment on lines 54 to 56
## SLEAP v1.3.2

_mm/dd/yyyy_
Copy link

Choose a reason for hiding this comment

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

The date placeholder _mm/dd/yyyy_ for SLEAP v1.3.2 should be replaced with the actual release date to maintain consistency and provide complete information.

- _mm/dd/yyyy_
+ 03/15/2023  # Example date, replace with the actual release date

Committable suggestion

IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
## SLEAP v1.3.2
_mm/dd/yyyy_
## SLEAP v1.3.2
03/15/2023 # Example date, replace with the actual release date

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 9e0e1c4 and 4a1a898.
Files selected for processing (1)
  • docs/bulletin.md (1 hunks)
Files skipped from review due to trivial changes (1)
  • docs/bulletin.md

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.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 4a1a898 and 0c9b54d.
Files selected for processing (1)
  • docs/bulletin.md (1 hunks)
Additional comments: 4
docs/bulletin.md (4)
  • 3-50: The release notes for SLEAP v1.3.3 are well-documented, providing clear information on the issues addressed, installation instructions, and links to the full changelog. The use of bold text for the pip installation command is a good way to highlight important information.

  • 50-50: Including a link to the full changelog is a good practice for maintaining traceability and providing users with a way to explore all changes in detail.

  • 54-56: The addition of the date for SLEAP v1.3.2 is consistent with the previous suggestion by roomrys. Ensure that all future updates to bulletin.md are made in the correct branch to keep changes organized.

  • 54-128: The release notes for SLEAP v1.3.2 are comprehensive, including highlights, fixes, dependencies, and new contributors. This level of detail is beneficial for users to understand the impact of the new version.

Comment on lines +23 to +37
### Quick install
**`mamba` (Windows/Linux/GPU)**:
```
mamba create -y -n sleap -c conda-forge -c nvidia -c sleap -c anaconda sleap=1.3.3
```

**`mamba` (Mac)**:
```
mamba create -y -n sleap -c conda-forge -c anaconda -c sleap sleap=1.3.3
```

**`pip` (any OS except Apple Silicon)**:
```
pip install sleap[pypi]==1.3.3
```
Copy link

Choose a reason for hiding this comment

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

Consider abstracting the installation instructions for mamba and pip to a common section to avoid duplication across different version release notes.

@shrivaths16 shrivaths16 requested review from talmo and removed request for talmo January 13, 2024 05:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants