This repo contains tooling around generating and publishing release notes for the Kubernetes organization.
A lightweight release notes UI to help users keep track of the ever-changing codebase for Kubernetes.
Local requirements:
git clone https://github.com/kubernetes-sigs/release-notes.git
(to generate any additional notes for development)Run npm install && npm start
from the root dir to start up the angular
development server (on port 4200
).
$ npm install
$ npm start
** Angular Live Development Server is listening on localhost:4200, open your browser on http://localhost:4200/ **
Any changes made to the front-end code (under src/
) will automatically be reflected.
To build and run the container container:
$ npm run docker:build:run
It will kick off a multi-stage docker
build to handle building the angular code and dumping it in a nginx container.
Once complete, you can view it by going to localhost
in your browser:
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)
In no particular order:
area/security
.area/feature
label, though no idea how to differentiate what's "new" yet.area/dependency
label to help generate External Dependencies.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.