Skip to content

Commit e4ace93

Browse files
author
Nisha K
committed
Added release notes for release 0.1.0
- Created new folder called 'releases' in docs to record release notes - Added v0_1_0.md release notes for v0.1.0 - Added link to release notes in README.md Signed-off-by: Nisha K <nishak@vmware.com>
1 parent 1815422 commit e4ace93

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,9 @@ $ python tests/<test file>.py
5959

6060
We try to keep the [project roadmap](./docs/project-roadmap.md) as up to date as possible. We are currently working on Release 0.1.0.
6161

62+
## Releases
63+
* [v0.1.0](docs/releases/v0_1_0.md)
64+
6265
## Documentation<a name="documentation"/>
6366
Architecture, function blocks, code descriptions and the project roadmap are located in the docs folder. We also welcome contributions to the documentation. See the [contributing guide](/CONTRIBUTING.md) to find out how to submit changes.
6467

docs/releases/v0_1_0.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Release v0.1.0
2+
3+
## Summary
4+
This is Tern's first release.
5+
6+
## Notes
7+
* Tern now uses Docker CLI only when working with Docker images. At this time, only images built by Docker are supported.
8+
* Tern uses overlayfs to step through container image filesystem layers. OverlayFS is supported in kernel version 4.0 or higher.
9+
* Tern requires root privileges to run because it needs to mount procfs in order to run commands within a chroot environment and call the Docker CLI. It is enough if you have configured sudo; Tern will ask for your password before running any priviledged commands.
10+
* You can give Tern a Dockerfile to build and inspect the resulting image. This is helpful either in a development environment or during build and release. This gives you some understanding on how your Dockerfile affects the packages installed in your container during a build.
11+
```
12+
$ ./tern report -d <path to Dockerfile>
13+
```
14+
* You can give Tern a local Docker image that you have pulled from a registry like Dockerhub. Tern will try to give as much information as it can obtain from the container image.
15+
```
16+
$ ./tern report -i <Docker image:tag>
17+
```
18+
* The Dockerfile and shell parser are still rudimentary. Please file an issue if it does not work for your Dockerfile or image.
19+
* The Command Library is still small. If you would like to contribute to it, please read our [contributing guidelines](CONTRIBUTING.md) and [this document](docs/adding-to-command-library.md).

0 commit comments

Comments
 (0)