Skip to content

Add note about v4 being an LTS release #2260

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.

Sign up for GitHub

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

Merged
joelhawksley merged 3 commits into from
Apr 3, 2025
Merged

Add note about v4 being an LTS release #2260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2fd8a40
add notes about LTS status of v4 release
joelhawksley Apr 3, 2025
21699d0
Update docs/CHANGELOG.md
joelhawksley Apr 3, 2025
187b5a4
Update docs/history.md
joelhawksley Apr 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@

## 4.0.0

Almost six years after releasing [v1.0.0](https://github.com/ViewComponent/view_component/releases/tag/v1.0.0), we are proud to ship ViewComponent 4. This release marks a shift towards a Long Term Support model for the project, having reached significant feature maturity. While contributions are always welcome, we are unlikely to accept further breaking changes or major feature additions.

Check failure on line 15 in docs/CHANGELOG.md

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'we're' instead of 'we are'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'we're' instead of 'we are'.", "location": {"path": "docs/CHANGELOG.md", "range": {"start": {"line": 15, "column": 314}}}, "severity": "ERROR"}

Check failure on line 15 in docs/CHANGELOG.md

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'we're' instead of 'we are'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'we're' instead of 'we are'.", "location": {"path": "docs/CHANGELOG.md", "range": {"start": {"line": 15, "column": 113}}}, "severity": "ERROR"}

This release makes the following breaking changes:

* BREAKING: Remove `use_deprecated_instrumentation_name` configuration option. Events will always use `render.view_component` name.

*Joel Hawksley*
Expand Down
2 changes: 2 additions & 0 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

_ViewComponent is intended to be a safe, welcoming space for collaboration. By participating you agree to abide by the [Contributor Code of Conduct](CODE_OF_CONDUCT.md)._

_As of version 4, ViewComponent is considered feature-complete. While contributions are always welcome, we are unlikely to accept further breaking changes or significant feature additions._

Check failure on line 11 in docs/CONTRIBUTING.md

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'we're' instead of 'we are'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'we're' instead of 'we are'.", "location": {"path": "docs/CONTRIBUTING.md", "range": {"start": {"line": 11, "column": 105}}}, "severity": "ERROR"}

Hi there! We're thrilled that you'd like to contribute to ViewComponent. Your help is essential for keeping it great.

If you have any substantial changes that you would like to make, please [open an issue](http://github.com/viewcomponent/view_component/issues/new) first to discuss them with us.
Expand Down
4 changes: 4 additions & 0 deletions docs/history.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,3 +214,7 @@ The largest consequence of this change is that we'll need to deprecate the old s
We propose that we make at least one release with the new API and no deprecation
warning followed by another release that includes the deprecation warning. This
will give teams some time to migrate before running into deprecation warnings.

## May 2024: ViewComponent 4

ViewComponent 4 is released and the project is moved into Long-Term Support, recognizing the feature-completeness of the framework.
2 changes: 2 additions & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

A framework for creating reusable, testable & encapsulated view components, built to integrate seamlessly with Ruby on Rails.

_As of version 4, ViewComponent is in Long-Term Support and generally considered feature-complete._

Check warning on line 11 in docs/index.md

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Microsoft.Adverbs] Consider removing 'generally'.

Raw Output:
{"message": "[Microsoft.Adverbs] Consider removing 'generally'.", "location": {"path": "docs/index.md", "range": {"start": {"line": 11, "column": 61}}}, "severity": "WARNING"}

## What's a ViewComponent?

ViewComponents are Ruby objects used to build markup. Think of them as an evolution of the presenter pattern, inspired by [React](https://reactjs.org/docs/react-component.html).
Expand Down
Loading