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 CHANGELOG.md #469

Merged
merged 1 commit into from
May 8, 2024
Merged

Update CHANGELOG.md #469

merged 1 commit into from
May 8, 2024

Conversation

justin808
Copy link
Member

@justin808 justin808 commented May 8, 2024

Summary

Pull Request checklist

  • Add/update test to cover these changes
  • Update documentation
  • Update CHANGELOG file

Other Information

Summary by CodeRabbit

  • Documentation
    • Updated changelog for version v8.0.0.rc.2 to note the removal of relative_url_root.

Copy link

coderabbitai bot commented May 8, 2024

Walkthrough

The recent update to shakapacker version v8.0.0.rc.2 introduces a notable breaking change. The relative_url_root setting has been removed by the contributor G-Rath. This modification could affect how paths are managed within the application, necessitating adjustments in user configurations.

Changes

File(s) Change Summary
CHANGELOG.md Removed relative_url_root setting.

🐇✨
In the code's meadow under the moon's glow,
A change was made, oh behold!
relative_url_root has hopped away,
With v8.0.0.rc.2 on this fine day!
Celebrate the leap, for new paths we'll tread,
Guided by the moonlit changes ahead! 🌕🚀


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.

@justin808 justin808 merged commit 46c7452 into main May 8, 2024
16 of 17 checks passed
@justin808 justin808 deleted the justin808-patch-1 branch May 8, 2024 02:01
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.

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 230a322 and 9ecac36.
Files selected for processing (1)
  • CHANGELOG.md (2 hunks)
Additional Context Used
LanguageTool (81)
CHANGELOG.md (81)

Near line 1: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: * For the changelog of versions prior to v6, see the [5.x stable branch of rails...


Near line 4: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...grading to new spelling in version 7. * Please see the [v6 Upgrade Guide](./docs/v6_up...


Near line 4: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...docs/v6_upgrade.md) to go from versions prior to v6. * [ShakaCode](https://www.shakacode...


Near line 5: Unpaired symbol: ‘[’ seems to be missing
Context: ... from versions prior to v6. * ShakaCode offers suppo...


Near line 13: Unpaired symbol: ‘[’ seems to be missing
Context: ... last non-beta release. ## [v8.0.0.rc.2] - May 7, 2024 ### Breaking changes - R...


Near line 35: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...G-Rath. - Remove https option for webpack-dev-server...


Near line 37: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...G-Rath. - Remove verify_file_existance method [PR 446]...


Near line 45: Possible missing comma found.
Context: ...additional_paths will have their path stripped just like with the source_path. [PR 4...


Near line 54: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ad of errors when compilation is success but stderr is not empty. [PR 416](https://g...


Near line 57: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...G-Rath](https://github.com/g-rath) ### Removed - Removes dependency on glob library. [PR 435](...


Near line 63: Possible missing article found.
Context: ...viously this could have been ignored in few code branches, especially when checking...


Near line 70: Unpaired symbol: ‘[’ seems to be missing
Context: ...ttps://github.com/tagliala). ## [v7.2.1] - December 30, 2023 ### Fixed - Show d...


Near line 75: Unpaired symbol: ‘[’ seems to be missing
Context: ...tps://github.com/ahangarha). ## [v7.2.0] - December 28, 2023 ### Added - Experi...


Near line 100: Unpaired symbol: ‘[’ seems to be missing
Context: ...acode/shakapacker/pull/363). ## [v7.0.3] - July 7, 2023 ### Fixed - Fixed comman...


Near line 100: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...acker/pull/363). ## [v7.0.3] - July 7, 2023 ### Fixed - Fixed commands execution fo...


Near line 101: Possible typo: you repeated a word
Context: ...l/363). ## [v7.0.3] - July 7, 2023 ### Fixed - Fixed commands execution for projects with sp...


Near line 104: Unpaired symbol: ‘[’ seems to be missing
Context: ...ttps://github.com/kukicola). ## [v7.0.2] - July 3, 2023 ### Fixed - Fixed creati...


Near line 104: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...b.com/kukicola). ## [v7.0.2] - July 3, 2023 ### Fixed - Fixed creation of assets:pr...


Near line 105: Possible typo: you repeated a word
Context: ...icola). ## [v7.0.2] - July 3, 2023 ### Fixed - Fixed creation of assets:precompile if it is ...


Near line 108: Unpaired symbol: ‘[’ seems to be missing
Context: ...tps://github.com/ahangarha). ## [v7.0.1] - June 27, 2023 ### Fixed - Fixed the c...


Near line 108: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...com/ahangarha). ## [v7.0.1] - June 27, 2023 ### Fixed - Fixed the condition for sho...


Near line 109: Possible typo: you repeated a word
Context: ...arha). ## [v7.0.1] - June 27, 2023 ### Fixed - Fixed the condition for showing warning for s...


Near line 112: Unpaired symbol: ‘[’ seems to be missing
Context: ...tps://github.com/ahangarha). ## [v7.0.0] - June 23, 2023 ### Breaking changes - ...


Near line 112: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...com/ahangarha). ## [v7.0.0] - June 23, 2023 ### Breaking changes - Removes defaults...


Near line 116: Possible missing comma found.
Context: ...ery file in the codebase was treated as TSX leading to potential issues. This has b...


Near line 116: Possible missing article found.
Context: ...s. This has been removed and returns to sensible default of the preset which is to figur...


Near line 116: Possible missing comma found.
Context: ... and returns to sensible default of the preset which is to figure out the file type fr...


Near line 116: Possible missing comma found.
Context: ...is change might affect generated output however so it is marked as breaking. - Export ...


Near line 140: ‘Prior to’ might be wordy. Consider a shorter alternative.
Context: ...dracz](https://github.com/tomdracz). Prior to this change, top level directory of sta...


Near line 140: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...com/tomdracz). Prior to this change, top level directory of static assets like images ...


Near line 140: Possible missing article found.
Context: ...and fonts was stripped. This meant that file in app/javascript/images/image.png wo...


Near line 142: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...tic/image.jpg")`. Going forward, the top level directory of static files will be retai...


Near line 142: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...rectory of static files will be retained so this will necessitate the update of fil...


Near line 149: Possible missing comma found.
Context: ...ery file in the codebase was treated as TSX leading to potential issues. This has b...


Near line 149: Possible missing article found.
Context: ...s. This has been removed and returns to sensible default of the preset which is to figur...


Near line 149: Possible missing comma found.
Context: ... and returns to sensible default of the preset which is to figure out the file type fr...


Near line 149: Possible missing comma found.
Context: ...is change might affect generated output however so it is marked as breaking. - Fixed R...


Near line 153: You’ve repeated a verb. Did you mean to only write one of them?
Context: ...arha](https://github.com/ahangarha) ### Removed - Remove redundant enhancement for precompile ta...


Near line 157: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...com/ahangarha). ## [v6.6.0] - March 7, 2023 ### Improved - Allow configuration of w...


Near line 161: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...alecslupu). ## [v6.5.6] - February 11, 2023 ### Fixed - Fixed failing to update `bi...


Near line 162: Possible typo: you repeated a word
Context: ...). ## [v6.5.6] - February 11, 2023 ### Fixed - Fixed failing to update bin/setup file due ...


Near line 180: Unpaired symbol: ‘[’ seems to be missing
Context: ...ttps://github.com/tagliala). ## [v6.5.4] - November 4, 2022 ### Fixed - Fixed re...


Near line 180: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...m/tagliala). ## [v6.5.4] - November 4, 2022 ### Fixed - Fixed regression caused by ...


Near line 181: Possible typo: you repeated a word
Context: ...a). ## [v6.5.4] - November 4, 2022 ### Fixed - Fixed regression caused by 6.5.3. PR #192 int...


Near line 184: Unpaired symbol: ‘[’ seems to be missing
Context: ...ttps://github.com/Eric-Guo). ## [v6.5.3] - November 1, 2022 ### Improved - Set ...


Near line 191: Unpaired symbol: ‘[’ seems to be missing
Context: ...acode/shakapacker/pull/192). ## [v6.5.2] - September 8, 2022 ### Upgrade Remove...


Near line 203: Unpaired symbol: ‘[’ seems to be missing
Context: ...duction" : "development" ``` ## [v6.5.1] - August 15, 2022 ### Improved - Resol...


Near line 214: Unpaired symbol: ‘[’ seems to be missing
Context: ...tps://github.com/pulkitkkr). ## [v6.5.0] - July 4, 2022 ### Added - `append_styl...


Near line 214: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ....com/pulkitkkr). ## [v6.5.0] - July 4, 2022 ### Added - `append_stylesheet_pack_tag...


Near line 221: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...ub.com/artemave) ## [v6.4.1] - June 5, 2022 ### Fixed - Restores automatic installa...


Near line 229: Unpaired symbol: ‘[’ seems to be missing
Context: ...ttps://github.com/tomdracz). ## [v6.4.0] - June 2, 2022 ### Fixed - Fixed [Issue...


Near line 229: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...b.com/tomdracz). ## [v6.4.0] - June 2, 2022 ### Fixed - Fixed [Issue 123: Rails 7.0...


Near line 230: Possible typo: you repeated a word
Context: ...dracz). ## [v6.4.0] - June 2, 2022 ### Fixed - Fixed [Issue 123: Rails 7.0.3 - Webpacker con...


Near line 234: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...se nested entries. This was the default prior to v6.0. Because entries maybe generated, ...


Near line 239: Unpaired symbol: ‘[’ seems to be missing
Context: ... assets:precompile task enhancement #131](https://github.com/shakacode/shakapacke...


Near line 239: Possible missing comma found.
Context: ...lled before asset precompilation. Going forward you will need to ensure these packages ...


Near line 239: If this is a question, use a question mark.
Context: ...tasks/yarn.rake) in your own application. ## [v6.3.0] - May 19, 2022 ### Improv...


Near line 241: Unpaired symbol: ‘[’ seems to be missing
Context: ...ke) in your own application. ## [v6.3.0] - May 19, 2022 ### Improved - Add abil...


Near line 256: The phrase “a variety of” may be wordy. To make your writing clearer, consider replacing it.
Context: ...e mode can affect how your code runs in a variety of ways, but in newer versions of Babel it...


Near line 260: You’ve repeated a verb. Did you mean to only write one of them?
Context: ... change probably won't affect you. ### Added - Adds webpacker_precompile setting to `webp...


Near line 267: The modal verb ‘will’ requires the verb’s base form.
Context: ...timestamp will be checked together will timestamps of all files and directories inside of ...


Near line 269: Possible missing comma found.
Context: ... in improved compiler checks performance but might be breaking for certain setups an...


Near line 274: Unpaired symbol: ‘[’ seems to be missing
Context: ...ttps://github.com/tomdracz). ## [v6.2.1] - April 15, 2022 ### Fixed - Put back c...


Near line 274: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...com/tomdracz). ## [v6.2.1] - April 15, 2022 ### Fixed - Put back config.public_mani...


Near line 278: Unpaired symbol: ‘[’ seems to be missing
Context: ...tps://github.com/justin808). ## [v6.2.0] - March 22, 2022 ### Added - Make mani...


Near line 288: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...ple invocations of stylesheet_pack_tag (eg for a regular stylesheet & a print styl...


Near line 291: Unpaired symbol: ‘[’ seems to be missing
Context: ...ttps://github.com/dleavitt). ## [v6.1.1] - February 6, 2022 ### Added - Support...


Near line 296: Unpaired symbol: ‘[’ seems to be missing
Context: ...ttps://github.com/tomdracz). ## [v6.1.0] - February 4, 2022 ### Added - Support ...


Near line 296: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...m/tomdracz). ## [v6.1.0] - February 4, 2022 ### Added - Support for SWC loader. [PR...


Near line 303: Unpaired symbol: ‘[’ seems to be missing
Context: .../rails/webpacker/pull/2802). ## [v6.0.2] - January 25, 2022 ### Improved - Fix i...


Near line 303: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: .../pull/2802). ## [v6.0.2] - January 25, 2022 ### Improved - Fix incorrect command na...


Near line 307: Unpaired symbol: ‘[’ seems to be missing
Context: ...ps://github.com/tricknotes). ## [v6.0.1] - January 24, 2022 ### Improved - PR #2...


Near line 307: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...tricknotes). ## [v6.0.1] - January 24, 2022 ### Improved - PR #21 removed pnp-webpa...


Near line 311: Unpaired symbol: ‘[’ seems to be missing
Context: ...k). ## [v6.0.0 changes from v6.0.0.rc.6] - January 22, 2022 ### Improved - Rais...


Near line 321: Unpaired symbol: ‘]’ seems to be missing
Context: ... Make watched_files_digest thread safe. [rails/webpacker #3233](https://github.co...


Near line 322: Unpaired symbol: ‘]’ seems to be missing
Context: ...ingle webpack config webpack.config.js. [rails/webpacker #3240](https://github.co...


Near line 340: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...r environment.js, this must be removed or you will receive an error (`Item nodeMo...


Near line 341: The preposition ‘to’ seems more likely in this position.
Context: ...iningCss. This is useful to enable HMR for React. - Webpacker's wrapper to the sp...


Near line 343: Unpaired symbol: ‘]’ seems to be missing
Context: ...'` per recommendation in the Babel docs [#2709](https://github.com/rails/webpacke...


Near line 344: Possible missing comma found.
Context: ...09) - Adds experimental Yarn 2 support. Note you must manually set `nodeLinker: node...


Near line 345: Unpaired symbol: ‘]’ seems to be missing
Context: ....yarnrc.yml`. - Fixes dev server issues [#2898](https://github.com/rails/webpacke...

Additional comments not posted (3)
CHANGELOG.md (3)

Line range hint 13-49: Verify the accessibility of PR links to ensure they are reachable and correct.

Verification successful

All PR links listed in the CHANGELOG.md for version v8.0.0.rc.2 of Shakapacker have been verified as accessible, each returning a HTTP 200 status code. This confirms that the links are correctly formatted and reachable, ensuring users can access the detailed information about each change.

All PR links in the CHANGELOG are verified and accessible:

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Check the accessibility of PR links in the CHANGELOG.md for version v8.0.0.rc.2.

# Test: Fetch each link and expect HTTP 200 status code.
links=(
  "https://github.com/shakacode/shakapacker/pull/413"
  "https://github.com/shakacode/shakapacker/pull/429"
  "https://github.com/shakacode/shakapacker/pull/439"
  "https://github.com/shakacode/shakapacker/pull/430"
  "https://github.com/shakacode/shakapacker/pull/412"
  "https://github.com/shakacode/shakapacker/pull/443"
  "https://github.com/shakacode/shakapacker/pull/414"
  "https://github.com/shakacode/shakapacker/pull/446"
  "https://github.com/shakacode/shakapacker/pull/415"
  "https://github.com/shakacode/shakapacker/pull/431"
  "https://github.com/shakacode/shakapacker/pull/447"
  "https://github.com/shakacode/shakapacker/pull/403"
  "https://github.com/shakacode/shakapacker/pull/454"
  "https://github.com/shakacode/shakapacker/pull/458"
)

for link in "${links[@]}"; do
  status=$(curl -o /dev/null -s -w "%{http_code}\n" "$link")
  if [ "$status" -ne 200 ]; then
    echo "Link $link is not accessible. Status: $status"
  else
    echo "Link $link is accessible."
  fi
done

Length of output: 5021


Line range hint 53-61: Verify the accessibility of PR links to ensure they are reachable and correct.

Verification successful

All PR links listed in the CHANGELOG.md for version v7.2.3 have been verified as accessible, each returning a HTTP 200 status code. This confirms that the links are correctly formatted and reachable.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Check the accessibility of PR links in the CHANGELOG.md for version v7.2.3.

# Test: Fetch each link and expect HTTP 200 status code.
links=(
  "https://github.com/shakacode/shakapacker/pull/416"
  "https://github.com/shakacode/shakapacker/pull/418"
  "https://github.com/shakacode/shakapacker/pull/435"
  "https://github.com/shakacode/shakapacker/pull/448"
)

for link in "${links[@]}"; do
  status=$(curl -o /dev/null -s -w "%{http_code}\n" "$link")
  if [ "$status" -ne 200 ]; then
    echo "Link $link is not accessible. Status: $status"
  else
    echo "Link $link is accessible."
  fi
done

Length of output: 1441


Line range hint 70-70: Verify the accessibility of the PR link to ensure it is reachable and correct.

Verification successful

The verification script successfully confirmed that the PR link mentioned in the CHANGELOG.md for version v7.2.1 is accessible, as it returned a HTTP 200 status code. This confirms that the link is correctly formatted and reachable, aligning with the requirements stated in the review comment.

Link Verification Complete:

  • The PR link https://github.com/shakacode/shakapacker/pull/400 is accessible and correctly leads to the intended destination.
Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Check the accessibility of the PR link in the CHANGELOG.md for version v7.2.1.

# Test: Fetch the link and expect HTTP 200 status code.
link="https://github.com/shakacode/shakapacker/pull/400"
status=$(curl -o /dev/null -s -w "%{http_code}\n" "$link")
if [ "$status" -ne 200 ]; then
  echo "Link $link is not accessible. Status: $status"
else
  echo "Link $link is accessible."
fi

Length of output: 334

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.

1 participant