Skip to content

Latest commit

 

History

History
87 lines (52 loc) · 2.59 KB

README.md

File metadata and controls

87 lines (52 loc) · 2.59 KB

Release Notes

Build Version

A lightweight release notes UI to help users keep track of the ever-changing codebase for Kubernetes.

Built with Angular, TypeScript, and Bootstrap.

Development

Prerequisites

Required:

  • Node.js and npm (see package.json engines field for version requirements)

Optional (only needed to generate new release notes):

Getting Started

Run npm install && npm start from the root directory to start the Angular development server on port 4200:

npm install
npm start

The application will be available at http://localhost:4200/

Any changes made to the source code (under src/) will automatically trigger a rebuild.

Build

Docker Build

To build the containerized application:

npm run docker:build

This runs a Docker build that sets up the development environment for the Angular application.

FAQ

Why?

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.

Can this be used for other projects?

With some changes, this could become a generic tool. There are no immediate plans to do that though.

Roadmap

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/feature label
  • Create structure for Urgent Upgrade Notes
  • Generate External Dependencies from area/dependency label
  • Highlight selected filter labels
  • Improved relationship between "options" and "notes"

Community, discussion, contribution, and support

Learn how to engage with the Kubernetes community on the community page.

You can reach the maintainers of this project at:

Code of conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.