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

Show current and next releases in the roadmap counter box #313

Merged
merged 6 commits into from
Jul 15, 2024

Conversation

Xpirix
Copy link
Collaborator

@Xpirix Xpirix commented Jul 8, 2024

This is the proposed fix for #311

image

Summary by CodeRabbit

  • New Features

    • Introduced a new layout for the roadmap to display release information, including version numbers and descriptions for Stable Release and Development Version milestones.
  • Style

    • Adjusted styles for roadmap elements to improve readability and alignment, particularly on mobile devices.
    • Added styles for a new .right-ribbon element to indicate different release states: stable, latest, and development.
    • Enhanced visual hierarchy with updated font-size and font-weight adjustments.

@Xpirix Xpirix requested a review from timlinux July 8, 2024 08:28
Copy link
Contributor

coderabbitai bot commented Jul 8, 2024

Walkthrough

The changes enhance the roadmap.sass and roadmap.html files in the Hugo Bulma Blocks theme. The CSS modifications improve the appearance and layout of roadmap elements, introducing new styles for mobile views and additional UI elements. The HTML updates restructure the display of release information, adding detailed and visually structured content for current and upcoming releases.

Changes

File Path Change Summary
.../hugo-bulma-blocks-theme/assets/sass/bulma/... Adjusted max-width, added position: relative, modified margins, and included styles for new elements.
.../hugo-bulma-blocks-theme/layouts/shortcodes/... Introduced a new layout for displaying release information with additional structured details.

Poem

In the code, a roadmap bright,
With styles set just right,
Release details now in sight,
Versions clear, a coder’s delight.
🎨✨
Enhanced with care, a visual spree,
For every user to now see.


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 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 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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between eca347e and a84889e.

Files selected for processing (4)
  • data/conf.json (1 hunks)
  • scripts/update-schedule.py (3 hunks)
  • themes/hugo-bulma-blocks-theme/assets/sass/bulma/components/roadmap.sass (1 hunks)
  • themes/hugo-bulma-blocks-theme/layouts/shortcodes/roadmap.html (3 hunks)
Files skipped from review due to trivial changes (2)
  • data/conf.json
  • themes/hugo-bulma-blocks-theme/assets/sass/bulma/components/roadmap.sass
Additional context used
Ruff
scripts/update-schedule.py

45-45: Use context handler for opening files

(SIM115)

Additional comments not posted (5)
scripts/update-schedule.py (2)

40-41: LGTM!

The new variables next_ltr_version and next_lr_version are correctly initialized to None.


141-142: LGTM!

The new variables next_lr_version and next_ltr_version are correctly set based on the input data.

themes/hugo-bulma-blocks-theme/layouts/shortcodes/roadmap.html (3)

13-21: LGTM!

The updated code correctly displays the current releases ltrrelease and release from the configuration data.


80-88: LGTM!

The updated code correctly displays the next releases next_ltr_version and next_lr_version from the configuration data.


106-111: LGTM!

The updated code correctly displays the current development version devversion from the configuration data.

@timlinux
Copy link
Member

image

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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a84889e and a5daae9.

Files selected for processing (2)
  • themes/hugo-bulma-blocks-theme/assets/sass/bulma/components/roadmap.sass (3 hunks)
  • themes/hugo-bulma-blocks-theme/layouts/shortcodes/roadmap.html (6 hunks)
Additional comments not posted (18)
themes/hugo-bulma-blocks-theme/assets/sass/bulma/components/roadmap.sass (8)

24-24: Approved: Added position: relative to .roadmap class.

This change ensures that the .right-ribbon element is correctly positioned relative to the .roadmap container.


30-30: Approved: Increased max-width for .steps-content to 200px.

This change likely improves the layout on mobile devices.


33-35: Approved: Added mobile rule for div elements inside .steps-content.

This change ensures better layout on mobile devices.


66-66: Approved: Set margin-left to 0 for .steps-content.

This change ensures proper alignment of .steps-content.


68-68: Approved: Set margin-left to 0.75rem for .steps-content on mobile devices.

This change ensures better spacing and layout on mobile devices.


81-81: Approved: Modified margin properties for .help-tip class.

This change likely improves the positioning and alignment of the .help-tip element.


149-212: Approved: Added new styles for .right-ribbon element.

These styles define the positioning, appearance, and variations for the .right-ribbon element.


180-212: Approved: Added new styles for pseudo-elements ::before and ::after of .right-ribbon span.

These styles enhance the appearance of the .right-ribbon element by adding decorative borders.

themes/hugo-bulma-blocks-theme/layouts/shortcodes/roadmap.html (10)

3-3: Approved: Accessed conf data from site's configuration using index.

This change ensures that the configuration data is correctly accessed and used within the template.


4-4: Approved: Added right-ribbon element for stable release version.

This change adds a visual indicator for the current stable release version.


11-14: Approved: Modified layout structure for stable release information.

This change improves the presentation of stable release information by providing more details and a structured layout.


25-30: Approved: Added layout structure for next LTR version.

This change adds a visual indicator for the next LTR version.


68-69: Approved: Modified layout structure for packaging information.

This change improves the presentation of packaging information by providing a structured layout.


79-80: Approved: Modified layout structure for installer availability information.

This change improves the presentation of installer availability information by providing a structured layout.


91-91: Approved: Accessed conf data from site's configuration for development version using index.

This change ensures that the configuration data for the development version is correctly accessed and used within the template.


92-92: Approved: Added right-ribbon element for development version.

This change adds a visual indicator for the current development version.


99-100: Approved: Modified layout structure for active development information.

This change improves the presentation of active development information by providing a structured layout.


112-113: Approved: Modified layout structure for feature freeze information.

This change improves the presentation of feature freeze information by providing a structured layout.

@Xpirix
Copy link
Collaborator Author

Xpirix commented Jul 11, 2024

Thanks for the hint @timlinux. Please find below a screenshot of the review.

roadmap-1

@Xpirix
Copy link
Collaborator Author

Xpirix commented Jul 11, 2024

I was also looking at the schedule table and have another proposition for the Development Version block. It's about renaming it to "Latest Release" so we will have 3.38 as the latest release version and 3.38.1 for the next latest point release,

roadmap-2

@timlinux
Copy link
Member

Yeah that looks so nice @Xpirix happy to apply that when you are ready (based on your second screenshot)

@Xpirix
Copy link
Collaborator Author

Xpirix commented Jul 12, 2024

Thanks, @timlinux. The changes for the second screenshot are now ready.

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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a5daae9 and 48bd655.

Files selected for processing (3)
  • themes/hugo-bulma-blocks-theme/assets/sass/bulma/components/roadmap.sass (3 hunks)
  • themes/hugo-bulma-blocks-theme/layouts/shortcodes/roadmap copy.html (1 hunks)
  • themes/hugo-bulma-blocks-theme/layouts/shortcodes/roadmap.html (7 hunks)
Files skipped from review as they are similar to previous changes (2)
  • themes/hugo-bulma-blocks-theme/assets/sass/bulma/components/roadmap.sass
  • themes/hugo-bulma-blocks-theme/layouts/shortcodes/roadmap.html
Additional comments not posted (3)
themes/hugo-bulma-blocks-theme/layouts/shortcodes/roadmap copy.html (3)

194-196: New clock initializations approved.

The added initializations for latest-point-release, freeze, and package are consistent with the existing pattern and are correctly implemented.


Line range hint 1-193:
Enhanced release information display structure approved.

The restructuring and addition of new elements to display release information provide a clearer and more detailed presentation. The changes are well-organized and logically structured.


Line range hint 148-193:
Clock initialization script approved.

The script for initializing clocks is correctly implemented and follows standard practices. It is sourced from an external example (CodePen) and is properly integrated.

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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 48bd655 and 0d2d92a.

Files selected for processing (1)
  • playwright/ci-test/tests/fixtures/roadmap-page.ts (1 hunks)
Files skipped from review due to trivial changes (1)
  • playwright/ci-test/tests/fixtures/roadmap-page.ts

@DelazJ
Copy link
Contributor

DelazJ commented Jul 12, 2024

Isn't it weird/confusing to mix 3.38 development cycle with the master branch? Afaict 3.38 has the same life cycle as 3.34, i.e. only release points with bug fixes after .0, every month.
OTOH, the next QGIS version follows a road map of 3months of development + 1 month of feature freeze before release.

@timlinux
Copy link
Member

Thanks @DelazJ

What about we add a third box for dev then make these changes:

  1. Rename the first box from 'Stable Release' to 'Long Term Release (LTR)' to reinforce consistent naming for LTRs
  2. Remove feature freeze and packaging from the Latest Release
  3. Add Feature Freeze and Packaging to the new third box with the heading of 'Development Version' - maybe with the ribbon saying Future: 3.40

@DelazJ
Copy link
Contributor

DelazJ commented Jul 13, 2024

What about we add a third box for dev then make these changes

Sounds good to me 👍🏿 @timlinux

@Xpirix
Copy link
Collaborator Author

Xpirix commented Jul 15, 2024

@timlinux @DelazJ

Please find below a screenshot of the reviewed version:

image

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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0d2d92a and 34e582e.

Files selected for processing (3)
  • playwright/ci-test/tests/fixtures/roadmap-page.ts (1 hunks)
  • themes/hugo-bulma-blocks-theme/assets/sass/bulma/components/roadmap.sass (4 hunks)
  • themes/hugo-bulma-blocks-theme/layouts/shortcodes/roadmap.html (7 hunks)
Files skipped from review due to trivial changes (1)
  • playwright/ci-test/tests/fixtures/roadmap-page.ts
Files skipped from review as they are similar to previous changes (1)
  • themes/hugo-bulma-blocks-theme/assets/sass/bulma/components/roadmap.sass
Additional comments not posted (9)
themes/hugo-bulma-blocks-theme/layouts/shortcodes/roadmap.html (9)

11-14: LGTM!

The changes to display the initial release information for the LTR version are correctly implemented.


68-69: LGTM!

The changes to display the packaging information for the LTR version are correctly implemented.


79-80: LGTM!

The changes to display the availability of installers for the LTR version are correctly implemented.


99-103: LGTM!

The changes to display the initial release information for the latest release are correctly implemented.


178-181: Verify CSS styling for the right-ribbon element.

Ensure that the right-ribbon element is styled properly in the CSS file to display the future version correctly.

Verification successful

Verified: CSS styling for the right-ribbon element is present and appears to be comprehensive.

The right-ribbon element has multiple CSS rules defined in the roadmap.sass file, including specific rules for different states such as development, ensuring proper styling.

  • themes/hugo-bulma-blocks-theme/assets/sass/bulma/components/roadmap.sass
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the CSS styling for the `right-ribbon` element.

# Test: Search for the CSS rules for the `right-ribbon` element. Expect: Proper styling rules.
rg --type sass '.right-ribbon'

Length of output: 1120


90-93: Verify CSS styling for the right-ribbon element.

Ensure that the right-ribbon element is styled properly in the CSS file to display the current version correctly.


2-5: Verify CSS styling for the right-ribbon element.

Ensure that the right-ribbon element is styled properly in the CSS file to display the current LTR version correctly.

Verification successful

CSS styling for the right-ribbon element is properly implemented.

The CSS rules for the .right-ribbon element are comprehensive and ensure correct styling for displaying the current LTR version.

  • The .right-ribbon element is positioned and styled appropriately.
  • Different states (.stable, .latest, .development) have distinct background colors.
  • Additional visual effects are applied using ::before and ::after pseudo-elements.
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the CSS styling for the `right-ribbon` element.

# Test: Search for the CSS rules for the `right-ribbon` element. Expect: Proper styling rules.
rg --type sass '.right-ribbon'

Length of output: 1120


Script:

#!/bin/bash
# Extract and display the CSS rules for the `right-ribbon` element from the SASS file.

# Display the relevant CSS rules
rg --type sass -A 5 '.right-ribbon' themes/hugo-bulma-blocks-theme/assets/sass/bulma/components/roadmap.sass

Length of output: 1208


113-118: Verify CSS styling for the rm-next class.

Ensure that the rm-next class is styled properly in the CSS file to highlight the next LR version correctly.

Verification successful

The rm-next class is styled properly.

The CSS rules for the rm-next class ensure that it has a bold font weight and a distinct color (#ee7913), which should effectively highlight the next LR version.

  • font-weight: 600
  • color: #ee7913
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the CSS styling for the `rm-next` class.

# Test: Search for the CSS rules for the `rm-next` class. Expect: Proper styling rules.
rg --type sass '.rm-next'

Length of output: 109


Script:

#!/bin/bash
# Extract and display the CSS rules for the `rm-next` class from the roadmap.sass file.
rg --type sass --context 5 '.rm-next' themes/hugo-bulma-blocks-theme/assets/sass/bulma/components/roadmap.sass

Length of output: 321


25-30: Verify CSS styling for the rm-current class.

Ensure that the rm-current class is styled properly in the CSS file to highlight the next LTR version correctly.

Verification successful

The .rm-current class is styled properly.

The CSS rules for the .rm-current class ensure that the text is bold and colored green, which is appropriate for highlighting the next LTR version.

  • themes/hugo-bulma-blocks-theme/assets/sass/bulma/components/roadmap.sass
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the CSS styling for the `rm-current` class.

# Test: Search for the CSS rules for the `rm-current` class. Expect: Proper styling rules.
rg --type sass '.rm-current'

Length of output: 115


Script:

#!/bin/bash
# Extract and display the CSS rules for the `.rm-current` class from the identified SASS file.
rg --type sass -A 5 '.rm-current' themes/hugo-bulma-blocks-theme/assets/sass/bulma/components/roadmap.sass

Length of output: 211

@dimasciput
Copy link
Collaborator

Screenshot 2024-07-15 at 08 45 37

@Xpirix perhaps center it vertically or reduce the height?

@Xpirix
Copy link
Collaborator Author

Xpirix commented Jul 15, 2024

@dimasciput Thanks. I've fixed it. It should be more aligned now.
image

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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 34e582e and 8abfdf9.

Files selected for processing (1)
  • themes/hugo-bulma-blocks-theme/layouts/shortcodes/roadmap.html (7 hunks)
Files skipped from review as they are similar to previous changes (1)
  • themes/hugo-bulma-blocks-theme/layouts/shortcodes/roadmap.html

@timlinux
Copy link
Member

Beautiful work as always @Xpirix . Thanks for your inputs @DelazJ and @dimasciput

@timlinux timlinux merged commit 95b6be8 into qgis:main Jul 15, 2024
2 checks passed
@DelazJ
Copy link
Contributor

DelazJ commented Jul 19, 2024

Nice. Thanks to all

This pull request was closed.
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.

4 participants