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

chore(master): release 3.0.0 #55

Merged

Conversation

lotyp
Copy link
Member

@lotyp lotyp commented Apr 15, 2024

πŸ€– I have created a release beep boop

3.0.0 (2024-04-18)

⚠ BREAKING CHANGES

  • changes in action directory structure

Features

  • changes in action directory structure (37f2dec)
  • refactoring s3 cache action (75eedec)
  • switch to rhysd/actionlint action linter (5a8f0e7)

Bug Fixes

  • Makefile and apply actionlint (1911f1a)

Documentation


This PR was generated with Release Please. See documentation.

Summary by CodeRabbit

  • New Features
    • Updated the repository to version 3.0.0 with improved directory structure and enhanced action linting capabilities.
  • Bug Fixes
    • Resolved issues related to Makefile configurations.
  • Documentation
    • Updated README files for better clarity and guidance.

Copy link

coderabbitai bot commented Apr 15, 2024

Walkthrough

Version 3.0.0 of the wayofdev/gh-actions repository introduces significant updates including a restructured action directory, adoption of a new action linter (rhysd/actionlint), and enhancements in the Makefile and documentation. These changes aim to improve the functionality and maintainability of the GitHub actions provided.

Changes

File Path Change Summary
.github/.release-please-manifest.json, package.json Updated version number from "2.0.0" to "3.0.0"
CHANGELOG.md Documented structural changes, linter switch, and other fixes

🐰🌟
In the meadow of code, under the sky so blue,
A version leaps to three, from the old two.
New paths are forged, and errors we mend,
With a hop and a skip, to the future we send!
πŸŽ‰πŸ“œπŸ› οΈ


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 19100c9 and e54ee74.
Files selected for processing (3)
  • .github/.release-please-manifest.json (1 hunks)
  • CHANGELOG.md (1 hunks)
  • package.json (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • .github/.release-please-manifest.json
  • package.json
Additional Context Used
LanguageTool (32)
CHANGELOG.md (32)

Near line 3: Unpaired symbol: β€˜[’ seems to be missing
Context: # Changelog ## [3.0.0](https://github.com/wayofdev/gh-actions/...


Near line 14: Possible spelling mistake found.
Context: ...2a181a2727d81c56d15d095c1)) * switch to rhysd/actionlint action linter ([5a8f0e7](htt...


Near line 14: Possible spelling mistake found.
Context: ...2727d81c56d15d095c1)) * switch to rhysd/actionlint action linter ([5a8f0e7](https://github...


Near line 19: Possible spelling mistake found.
Context: ...) ### Bug Fixes * Makefile and apply actionlint ([1911f1a](https://github.com/wayofdev/...


Near line 24: Possible spelling mistake found.
Context: ...2389adc0a1)) ### Documentation * add actionlint in contributing ([f261935](https://gith...


Near line 25: Possible spelling mistake found.
Context: ...e397744bc4f38262704c1b77993e643)) * add changesets workflow ([fdb97ac](https://github.com/...


Near line 28: Possible spelling mistake found.
Context: ...1d4920863de403015b214afdb2c2)) * update readme ([9519cd0](https://github.com/wayofdev/...


Near line 29: Possible spelling mistake found.
Context: ...792a2c4d609daa552d896112aa)) * updating readme files ([bbcbf86](https://github.com/way...


Near line 31: Unpaired symbol: β€˜[’ seems to be missing
Context: ...f3aca34555ff19f01bee9367b18)) ## [2.0.0](https://github.com/wayofdev/gh-actions/...


Near line 40: Possible spelling mistake found.
Context: ... ### Features * add action to install phive dependencies ([072115b](https://github....


Near line 41: Possible spelling mistake found.
Context: ...8c1721cd)) * add build-image workflow ([feabbbb](https://github.com/wayofdev/gh-actions...


Near line 42: Possible spelling mistake found.
Context: ...793bd047b7eb18561a303c11bcb215d)) * add commitlint configuration and github action to lint...


Near line 42: The official name of this software platform is spelled with a capital β€œH”.
Context: ...5d)) * add commitlint configuration and github action to lint commits ([f85d90b](https...


Near line 44: Possible spelling mistake found.
Context: ...68d)) * add create-release action using changesets ([9eb0c8d](https://github.com/wayofdev/...


Near line 47: Possible spelling mistake found.
Context: ...febfc411dd71f9454ba2bc117ab5d76)) * add pnpm composite install action ([b491bc8](htt...


Near line 51: Possible spelling mistake found.
Context: ...f0ba36141ff1ef72638bf5bc6b46ac5)) * add yamllint action and Makefile support ([f85d90b](...


Near line 53: Did you mean β€œpassing”? Or maybe you should add a pronoun? In active voice, β€˜allow’ + β€˜to’ takes an object, usually a pronoun.
Context: ...d82bd55f5db50682b4d121f4b6393)) * allow to pass custom head reference ([3fddee2](https:...


Near line 54: Did you mean β€œpassing”? Or maybe you should add a pronoun? In active voice, β€˜allow’ + β€˜to’ takes an object, usually a pronoun.
Context: ...76edb19d9c0a1e6e460446f345484)) * allow to pass platform in docker-build ([38174a4](htt...


Near line 55: To make your text as clear as possible to all readers, do not use this foreign term. Possible alternatives are β€œbelow” or β€œfurther on” (in a document).
Context: ...a409e8d5bb48c4cac41daa0033a08e36989)) * infra files, fixes in actions ([22fb724](http...


Near line 58: Possible spelling mistake found.
Context: ...bdb5c2e4d577327c3a09a83bea58ed02cba)) * shellcheck workflow ([bd17f4e](https://github.com/...


Near line 67: Possible spelling mistake found.
Context: ...:** update dependency @action-validator/cli to v0.5.2 ([65ef3ea](https://github.com...


Near line 68: Possible spelling mistake found.
Context: ...:** update dependency @action-validator/cli to v0.5.3 ([2c7175d](https://github.com...


Near line 69: Possible spelling mistake found.
Context: ...:** update dependency @action-validator/cli to v0.5.4 ([ca064e4](https://github.com...


Near line 70: Possible spelling mistake found.
Context: ...:** update dependency @action-validator/cli to v0.6.0 ([6782647](https://github.com...


Near line 78: Possible spelling mistake found.
Context: ...2a2df17173075c4c05b64da4d1d)) * replace pnpm to pnpx to resolve ENOENT playwrite ([8...


Near line 78: Possible spelling mistake found.
Context: ...73075c4c05b64da4d1d)) * replace pnpm to pnpx to resolve ENOENT playwrite ([85d80da](...


Near line 78: Possible spelling mistake found.
Context: ...d1d)) * replace pnpm to pnpx to resolve ENOENT playwrite ([85d80da](https://github.com...


Near line 78: Possible spelling mistake found.
Context: ... replace pnpm to pnpx to resolve ENOENT playwrite ([85d80da](https://github.com/wayofdev/...


Near line 80: The official name of this software platform is spelled with a capital β€œH”.
Context: ...2bca873d6c52178fcf43943)) * secret name github_token within workflow_call can not b...


Near line 80: Unless you want to emphasize β€œnot”, use β€œcannot” which is more common.
Context: ...e github_token within workflow_call can not be used since it would collide with sys...


Near line 81: Possible spelling mistake found.
Context: ...6004c5ff5f16dde27866eea380b46b09dd1)) * shellcheck ([8564406](https://github.com/wayofdev/...


Near line 82: Possible spelling mistake found.
Context: ...06a4acb4632638c4d37ac10709fd1981e71)) * shellcheck upload ([7f11fa0](https://github.com/wa...

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

6-8: The documentation of breaking changes is clear and concise.


10-14: All feature updates are well-documented with appropriate links to the commits.


17-19: Bug fixes are clearly documented with links to the relevant commits.


22-29: Documentation updates are thoroughly detailed with links to the respective commits.


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

@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

CHANGELOG.md Outdated
Comment on lines 5 to 16

### Features

* switch to rhysd/actionlint action linter ([5a8f0e7](https://github.com/wayofdev/gh-actions/commit/5a8f0e7bf9413b7d42da6b2fdfb4746f8d5e1f99))


Copy link

Choose a reason for hiding this comment

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

Reduce multiple consecutive blank lines to a single blank line to improve readability.


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
### Features
* switch to rhysd/actionlint action linter ([5a8f0e7](https://github.com/wayofdev/gh-actions/commit/5a8f0e7bf9413b7d42da6b2fdfb4746f8d5e1f99))
### Features
* switch to rhysd/actionlint action linter ([5a8f0e7](https://github.com/wayofdev/gh-actions/commit/5a8f0e7bf9413b7d42da6b2fdfb4746f8d5e1f99))

CHANGELOG.md Outdated
Comment on lines 16 to 30
### Documentation

* update readme ([9519cd0](https://github.com/wayofdev/gh-actions/commit/9519cd017ee5be792a2c4d609daa552d896112aa))

Copy link

Choose a reason for hiding this comment

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

Reduce multiple consecutive blank lines to a single blank line to improve readability.


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
### Documentation
* update readme ([9519cd0](https://github.com/wayofdev/gh-actions/commit/9519cd017ee5be792a2c4d609daa552d896112aa))
### Documentation
* update readme ([9519cd0](https://github.com/wayofdev/gh-actions/commit/9519cd017ee5be792a2c4d609daa552d896112aa))

@lotyp lotyp changed the title chore(master): release 2.1.0 chore(master): release 3.0.0 Apr 16, 2024
@lotyp lotyp force-pushed the release-please--branches--master--components--gh-actions branch 2 times, most recently from 6e5720c to 0a63603 Compare April 16, 2024 23:36
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: 4

Actionable comments outside the diff hunks (2)
CHANGELOG.md (2)

Line range hint 58-58: Reduce multiple consecutive blank lines to a single blank line to improve readability.

-

Line range hint 81-81: Reduce multiple consecutive blank lines to a single blank line to improve readability.

-

CHANGELOG.md Show resolved Hide resolved
CHANGELOG.md Show resolved Hide resolved
CHANGELOG.md Show resolved Hide resolved
@lotyp lotyp force-pushed the release-please--branches--master--components--gh-actions branch 2 times, most recently from 4843d55 to 3615f86 Compare April 18, 2024 21:14
@lotyp lotyp force-pushed the release-please--branches--master--components--gh-actions branch from 3615f86 to e54ee74 Compare April 18, 2024 23:14
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: 1

CHANGELOG.md Show resolved Hide resolved
@lotyp
Copy link
Member Author

lotyp commented Apr 18, 2024

Walkthrough

Version 3.0.0 of the wayofdev/gh-actions repository introduces significant updates including a restructured action directory, adoption of a new action linter (rhysd/actionlint), and enhancements in the Makefile and documentation. These changes aim to improve the functionality and maintainability of the GitHub actions provided.

Changes

File Path Change Summary
.github/.release-please-manifest.json, package.json Updated version number from "2.0.0" to "3.0.0"
CHANGELOG.md Documented structural changes, linter switch, and other fixes

🐰🌟
In the meadow of code, under the sky so blue,
A version leaps to three, from the old two.
New paths are forged, and errors we mend,
With a hop and a skip, to the future we send!
πŸŽ‰πŸ“œπŸ› οΈ

Recent Review Details
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.

@lotyp lotyp closed this Apr 18, 2024
@lotyp lotyp reopened this Apr 18, 2024
Copy link

coderabbitai bot commented Apr 18, 2024

Tip

For best results, initiate chat on the files or code changes.

@lotyp, thank you for the detailed walkthrough and the poetic touch in celebrating the release of version 3.0.0 of the wayofdev/gh-actions repository! It's great to see such comprehensive updates aimed at improving functionality and maintainability. 🌟

Your efforts in documenting the changes and engaging with the community are truly appreciated. If there's anything specific you'd like assistance with, or if you have any questions about the new features or the repository in general, feel free to reach out. Happy coding! πŸš€

Also, thank you for considering giving CodeRabbit a shout-out. Support from the community is invaluable to us! πŸ°πŸ’¬

@lotyp lotyp merged commit 4a49f30 into master Apr 18, 2024
4 checks passed
@lotyp lotyp deleted the release-please--branches--master--components--gh-actions branch April 18, 2024 23:22
@lotyp
Copy link
Member Author

lotyp commented Apr 18, 2024

πŸ€– Release is at https://github.com/wayofdev/gh-actions/releases/tag/v3.0.0 🌻

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant