Skip to content

Commit

Permalink
Added release notes for release 0.1.0
Browse files Browse the repository at this point in the history
- 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 <[email protected]>
  • Loading branch information
Nisha K committed Jul 19, 2018
1 parent 1815422 commit e4ace93
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ $ python tests/<test file>.py

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.

## Releases
* [v0.1.0](docs/releases/v0_1_0.md)

## Documentation<a name="documentation"/>
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.

Expand Down
19 changes: 19 additions & 0 deletions docs/releases/v0_1_0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Release v0.1.0

## Summary
This is Tern's first release.

## Notes
* Tern now uses Docker CLI only when working with Docker images. At this time, only images built by Docker are supported.
* Tern uses overlayfs to step through container image filesystem layers. OverlayFS is supported in kernel version 4.0 or higher.
* 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.
* 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.
```
$ ./tern report -d <path to Dockerfile>
```
* 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.
```
$ ./tern report -i <Docker image:tag>
```
* The Dockerfile and shell parser are still rudimentary. Please file an issue if it does not work for your Dockerfile or image.
* 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 comments on commit e4ace93

Please sign in to comment.