A lightweight release notes UI to help users keep track of the ever-changing codebase for Kubernetes.
Built with Angular, TypeScript, and Bootstrap.
Required:
- Node.js and npm (see
package.jsonengines field for version requirements)
Optional (only needed to generate new release notes):
- Go
- release-notes CLI tool to generate JSON files
Run npm install && npm start from the root directory to start the Angular development server on port 4200:
npm install
npm startThe application will be available at http://localhost:4200/
Any changes made to the source code (under src/) will automatically trigger a rebuild.
To build the containerized application:
npm run docker:buildThis runs a Docker build that sets up the development environment for the Angular application.
Release notes can and should be better. Empowering end-users to view what they need, while also being able to highlight important info, is our goal.
It does involve some engineering effort, but this is a case where technology can help us and we should not incur much technical debt.
Also it's cool.
With some changes, this could become a generic tool. There are no immediate plans to do that though.
Some of these may be blocked by external dependencies (such as GitHub labels not existing):
- Advanced filtering with AND/OR logic
- Generate Security Content from PRs with
area/security - Generate Known Issues from issues with release milestones
- Generate New Features from PRs with
area/featurelabel - Create structure for Urgent Upgrade Notes
- Generate External Dependencies from
area/dependencylabel - Highlight selected filter labels
- Improved relationship between "options" and "notes"
Learn how to engage with the Kubernetes community on the community page.
You can reach the maintainers of this project at:
Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.