This repository has been archived by the owner on Oct 13, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add deprecation notice in README (#819)
- Loading branch information
1 parent
2963326
commit 0a73132
Showing
1 changed file
with
1 addition
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,46 +1 @@ | ||
## Doozer | ||
|
||
[![PyPI version](https://badge.fury.io/py/rh-doozer.svg)](https://badge.fury.io/py/rh-doozer) | ||
[![codecov](https://codecov.io/gh/openshift/doozer/branch/master/graph/badge.svg)](https://codecov.io/gh/openshift/doozer) | ||
|
||
Doozer is a build management utility that currently has the capability to build RPMs and Container Images via OSBS/Brew | ||
|
||
## Deployment | ||
|
||
_**Note**: This is for running the full, local python `doozer` client, not the containerized version. This requires other dependencies discussed in the [Installation doc](Installation.md)._ | ||
|
||
For local development pull the code and run: | ||
|
||
`pip3 install --user -e .` | ||
|
||
For new releases, Jenkins is already setup and deployment to PyPi is easy: | ||
|
||
- Bump the version in `./doozerlib/VERSION` | ||
- Push the change to `master` | ||
- Create a new GitHub release: https://github.com/openshift-eng/doozer/releases/new | ||
|
||
That's it. Jenkins will do the rest automatically. | ||
|
||
|
||
## Installation | ||
|
||
If you just want to use `doozer` checkout the [container usage doc](Container.md). | ||
|
||
If you need to develop for doozer checkout the full [installation doc](Installation.md). | ||
|
||
## License | ||
|
||
Most of doozer is released under [Apache License 2.0][], except [doozerlib/dotconfig.py][] and | ||
[doozerlib/gitdata.py][], which are embedded copies of [dotconfig][] and [gitdata][] projects | ||
respectively, therefore those two files are released under [LGPL v3][]. | ||
|
||
## Usage | ||
|
||
Checkout the [Usage doc](Usage.md) | ||
|
||
[Apache License 2.0]: https://github.com/openshift-eng/doozer/blob/master/LICENSE | ||
[doozerlib/dotconfig.py]: https://github.com/openshift-eng/doozer/blob/master/doozerlib/dotconfig.py | ||
[doozerlib/gitdata.py]: https://github.com/openshift-eng/doozer/blob/master/doozerlib/gitdata.py | ||
[dotconfig]: https://github.com/adammhaile/dotconfig | ||
[gitdata]: https://github.com/adammhaile/gitdata | ||
[LGPL v3]: https://www.gnu.org/licenses/lgpl-3.0.en.html | ||
This repository is deprecated, please go to the new location at https://github.com/openshift-eng/art-tools/tree/main/doozer |