-
Notifications
You must be signed in to change notification settings - Fork 40
Hyperstack 1.0 Release Roadmap and Process
The specific goals of the Hyperstack 1.0 release in addition to implementing the defined Hyperstack Architecture are:
- Runs out of the box (i.e. add gem and run the installer) on Rails 5.0 and 6.0, both on new and existing applications.
- Optionally will work with Webpacker
- High quality, easy to access documentation, tutorials, and examples.
- Hyper Model supports a well defined subset of the ActiveRecord API (the subset needs to be documented but the roadmap assumes it is the currently implemented subset, plus any specific issues that get raised and are agreed on.)
- Integrated Hotloading
- Improved Hyperspec DSL
- Straight forward deployment to production
- Compatible with Opal 1.0
- DSL generates React functional components
Note: These are open to change... please feel free to discuss in the main hyperstack slack chat area or on specific github issues in question. Join Hyperstack Slack Channel
A lot of the above is complete, and there are production applications running on the alpha1.5 release. the major improvements and work remaining to done includes:
- Improved website
- More tutorials and examples
- Rewrite of the HyperComponent-React wrapper to fully use React functional components
- Optional use of Redis to manage broadcast channels
- Improved Hyperspec DSL and performance
These are the major updates needed. In addition there are other issues on github that will be closed as well.
The following are desirable features, but currently are not included in 1.0. If you feel differently please comment on the associated issue.
Also note that we welcome contributions in any of these areas. If you get one of these features working before the 1.0 release it will happily be considered for inclusion.
- Out-of-the-box compatibility with Rails 4 (issue 130)
- Rack App instead of Rails Gem (issue 239)
- Client side code delivered an NPM module (issue 241)
- Lazy Loading (issue 240)
- Non-SQL Adapters (issue 243)
- Hyper Model to API Adapter Tools (issue 244)
- Define a more readable, non-active-record based API between Hyper Model client and Server (issue 246)
- Support for AnyCable (issue 187)
The roadmap to the Hyperstack 1.0 release is managed using
- This wiki page which defines the overall goals of the 1.0 release,
- github projects,
- github milestones,
- github issue labels,
- github issues and
- the Hyperstack slack chat
All changes to the code base and/or documentation are tagged with at least one issue that has been placed in the Alpha to Production project.
The next complete gem set is released as a 1.0 release candidate named 1.0.alpha1.x
The definition of each release candidate can be found on the releases page as well as in the change log
You can obtain the latest release candidate by using gem 'rails-hyperstack, '~> 1.0.alpha1.0'`
- open alpha 1.5 issues
- open alpha 1.6 issues
- open alpha 1.7 issues
- open alpha 1.8 issues
- open alpha 1.9 issues
The edge branch represents a stable gemset that while not yet released, is passing all specs. As issues are fixed they are merged into the edge branch, and are marked with the ready-to-release label
You can try out the edge branch by using
gem 'rails-hyperstack',
git: 'git://github.com/hyperstack-org/hyperstack.git',
branch: 'edge',
glob: 'ruby/*/*.gemspec'Issues closed in edge (ready-to-release)
Every change to code or documentation is defined as at least one issue. Issues have one or more labels to help determine the point of the issue, and decide if it will be included in the eventual 1.0 release.
Anyone may raise an issue. One of the core team will then label the issue appropriately. If the issue needs general discussion it will be tagged with the discussion label.
Anybody can create a new issue, and creating an issue is the easiest way to get started contributing to Hyperstack.