Skip to content

Commit

Permalink
docs: Update the project roadmap for 2020
Browse files Browse the repository at this point in the history
- Updated the project roadmap for 2020 and moved 2019's roadmap to
  the archive.
- Updated the Project Status section of the README to show the new
  release and update the list of releases to date.
- Updated the release checklist to add a step to update the Project
  Status section of the README.

Signed-off-by: Nisha K <[email protected]>
  • Loading branch information
Nisha K authored and rnjudge committed Apr 15, 2020
1 parent 797b2c6 commit a01047b
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 25 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -270,13 +270,12 @@ $ python tests/<test file>.py
```

## Project Status<a name="project-status"/>
Release 1.0.0 was released at the beginning of November. A follow-up release, v1.0.1, was made available at the beginning of December to address a regression found when running Tern in a Docker container.
Release 2.0.0 is out! See the [release notes](docs/releases/v2_0_0.md) for more information.

See the [release notes](docs/releases/v1_0_0.md) for more information. See the [update notes](docs/releases/v1_0_1.md) for patches on top of this release.

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

## Releases
* [v2.0.0](docs/releases/v2_0_0.md)
* [v1.0.1](docs/releases/v1_0_1.md)
* [v0.5.4](docs/releases/v0_5_4.md)
* [v0.4.0](docs/releases/v0_4_0.md)
Expand Down
24 changes: 24 additions & 0 deletions docs/project-roadmap-archive.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,27 @@
## 2020-04-15
### 2019

Since 2018, Tern has [joined the Linux Foundation](https://www.linuxfoundation.org/press-release/2018/12/the-linux-foundation-to-launch-new-tooling-project-to-improve-open-source-compliance/). As a result, many of the project's goals will be aligned with the goals of the ACT project. This basically means some more resources will go towards making the project easier for developers to use while *gently* motivating them to follow some best practices. We will also be focusing on allowing Tern to better integrate with these and other projects.

For Release 0.4.0 dated May 2019, we will be focusing on the [SPDX superbug](https://github.com/vmware/tern/issues/174).

CI/CD for the project became a priority. We can't sustain further community growth without it. So for release 0.5.4 dated August 2019, we focused on these items:

- Setting up Circle CI to run linting with Prospector
- Setting up a Build and Release pipeline where PyPI package managers
- Setting up Circle CI to run tests based on files touched

This was a relatively small release as one of the maintainers was on vacation in July.

For Release 1.0.0 slated for November of 2019, we will focus on the following:

- Using the [stevedore](https://github.com/openstack/stevedore) module to dynamically load reporting formats.
- Some refactoring to allow external tools to be integrated into Tern.
- Some refactoring to allow containers built using other tools. This includes enabling Tern to use a raw container image tarball.
- Some refactoring to allow language level package managers. We will focus on pip
- Bug fixes and technical debt.


## 2019-02-27
### 2018
The end goal for 2018 is to make the project relevant to real world containers and to make it easy to contribute to it. Milestones for the project can be discussed on the community slack channel or the public forum. See the [contributing guide](../CONTRIBUTING.md) for information on how to join the conversation.
Expand Down
34 changes: 13 additions & 21 deletions docs/project-roadmap.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,18 @@
# Project Road Map

## 2019

Since 2018, Tern has [joined the Linux Foundation](https://www.linuxfoundation.org/press-release/2018/12/the-linux-foundation-to-launch-new-tooling-project-to-improve-open-source-compliance/). As a result, many of the project's goals will be aligned with the goals of the ACT project. This basically means some more resources will go towards making the project easier for developers to use while *gently* motivating them to follow some best practices. We will also be focusing on allowing Tern to better integrate with these and other projects.

For Release 0.4.0 dated May 2019, we will be focusing on the [SPDX superbug](https://github.com/vmware/tern/issues/174).

CI/CD for the project became a priority. We can't sustain further community growth without it. So for release 0.5.4 dated August 2019, we focused on these items:

- Setting up Circle CI to run linting with Prospector
- Setting up a Build and Release pipeline where PyPI package managers
- Setting up Circle CI to run tests based on files touched

This was a relatively small release as one of the maintainers was on vacation in July.

For Release 1.0.0 slated for November of 2019, we will focus on the following:

- Using the [stevedore](https://github.com/openstack/stevedore) module to dynamically load reporting formats.
- Some refactoring to allow external tools to be integrated into Tern.
- Some refactoring to allow containers built using other tools. This includes enabling Tern to use a raw container image tarball.
- Some refactoring to allow language level package managers. We will focus on pip
- Bug fixes and technical debt.
## 2020
We are getting very close to a beta release. The requirements for this release are:
1. Support for language package managers.
2. Ability to run on Mac and Windows using Docker.

Our goal is to meet these requirements by the end of the year
- We will work towards enabling language package managers like `pip`, `npm` and `gem` including support for golang which will be available in future releases slated for this year.
- We will try to move away from using overlayfs to "debug" container images. This will allow us to move away from using a volume mount to a host linux system to make Tern work on Windows and Mac. However, this will not help towards running Tern in an unprivileged container (at least in the default environment).

We will also continue to work on the following:
- We will continue to support the SPDX format for container images. To that end, we will make changes to update the format of the document as the [spec](https://spdx.org/sites/cpstandard/files/pages/files/spdxversion2.1.pdf) evolves.
- We will be working with the [Conan](https://github.com/nexB/conan) project to integrate some of the functionality needed by their use cases.
- As usual, we will continue to work on our technical debt and bug fixes.

This timetable is based on time, resources and feedback from you and will change accordingly.

Expand Down
2 changes: 2 additions & 0 deletions docs/releases/release_checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ This is a checklist for cutting a release
- Contributors (look at Authors in the changelog `git log --pretty=format:"%an %ae" v<tag>..master | sort | uniq`). Remove the maintainers name from the contributor list.
- Contact the Maintainers

* Update the Project Status part of the README.md to reflect this release and add it to the list of releases.

- [ ] Commit release notes and create patch for your changes
* `git add` and `git commit` any changes. This will likely include`v<release>-requirements.txt`, any changes to `requirements.txt` and `v<release>.md`. **Do not push these changes to master!**
* Run `git format-patch -n1`. This will create a patch file of the release changes you just committed called `0001-<commit_title>.patch`.
Expand Down

0 comments on commit a01047b

Please sign in to comment.