docs : Automate release notes

[jcvenegas]

This patch adds a script to generate release notes.

Usage
./docs/release_notes.sh <start-commit/tag>

start-commit/tag is the commit to start to get git changes.

Example:

$./docs/release_notes.sh 3.0.0-alpha.5 3.0.0.beta.1

Fixes #409

Signed-off-by: Jose Carlos Venegas Munoz [email protected]

[jcvenegas]

Example running:

 ./docs/release_notes.sh 3.0.0-alpha.5 3.0.0.beta.1

Release 3.0.0.beta.1

Changes

• qemu: Move from pc-lite to pc machine type
• docs: Document limitations.
• config: support kernel parameters
• build: configuration file depends on build variables

Shortlog

8a38fa7 qemu: Move from pc-lite to pc machine type
56e96d3 docs: Document limitations.
528772f config: support kernel parameters
2c456d7 build: configuration file depends on build variables

Compatibility with Docker

Clear Containers 3.0.0.beta.1 is compatible with Docker v17.06-ce

OCI Runtime Specification

Clear Containers 3.0.0.beta.1 support the OCI Runtime Specification 1.0.0-rc5

Clear Linux Containers image

Clear Containers 3.0.0.beta.1 requires at least Clear Linux containers image 16910

Clear Linux Containers Kernel

Clear Containers 3.0.0.beta.1 requires at least Clear Linux Containers kernel cc-linux-4.9.35

Installation

• Ubuntu
• Fedora
• Developers

Issues & limitations

Networking

Adding networks dynamically

Resource management

docker run -m

See issue #381 for more information.

docker run --cpus=

See issue #341 for more information.

docker run --kernel-memory=

See issue #388 for more information.

shm

cgroup constraints

Capabilities

See issue #51 for more information.

sysctl

tmpfs

Other

checkpoint and restore

docker stats

See issue #200 for more information.

runtime commands

ps command

See issue #95 for more information.

events command

See issue #379 for more information.

update command

See issue #380 for more information.

Networking

Support for joining an existing VM network

docker --net=host

docker run --link

Host resource sharing

docker --device

docker -v /dev/...

docker run --privileged

Other

Annotations

runtime commands

init command

spec command

More information Limitations

[coveralls]

Coverage remained the same at 55.39% when pulling d5bec43 on jcvenegas:jcvenegas/automate-release-notes into 2eeb4f4 on clearcontainers:master.

[sboeuf]

@jcvenegas I like this kind of patch :)
Good thing to automate the release.

[grahamwhaley]

I think this is a good thing (tm) :-)
I will add the note - once we have run the script we should never blindly trust the output - we still need to visually check and potentially massage the data (sometimes commit messages can be trimmed or improved or don't need to belong in the release notes for instance).
And, a note to all, now you have even more motivation to be vigilant on your commit/merge subject lines, as they are likely to end up in the release notes.
lgtm
adding @jodh-intel as a reviewer.

[jodh-intel]

Just needs a header on the script and I'm happy with this.

[jodh-intel]

Missing copyright header.

[jcvenegas]

Added

[jodh-intel]

This file gets everywhere! 😄

[jodh-intel]

(not related to this PR [yet], but it'll be nice to get CentOS/RHEL added here when #372 lands).

[coveralls]

Coverage remained the same at 55.39% when pulling 1527806 on jcvenegas:jcvenegas/automate-release-notes into 2eeb4f4 on clearcontainers:master.

[coveralls]

Coverage remained the same at 55.39% when pulling fbd04de on jcvenegas:jcvenegas/automate-release-notes into 5dea7cb on clearcontainers:master.

[sboeuf]

Please rebase the PR so that it runs with the new agent code.

[devimc]

lgtm

[coveralls]

Coverage remained the same at 55.39% when pulling 4674607 on jcvenegas:jcvenegas/automate-release-notes into 7bde8a9 on clearcontainers:master.

[jodh-intel]

lgtm