-
Notifications
You must be signed in to change notification settings - Fork 168
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Makefile target for tagging a release
Signed-off-by: Yuri Shkuro <[email protected]>
- Loading branch information
1 parent
2095173
commit f15ab41
Showing
2 changed files
with
23 additions
and
2 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
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 |
---|---|---|
|
@@ -11,9 +11,13 @@ Before creating a new release: | |
`git remote add upstream [email protected]:jaegertracing/documentation.git` | ||
- Make sure you are on your `main` branch. | ||
|
||
Then create a release by pushing a tag corresponding to the jaegertracing/jaeger version `release-X.Y.Z`, e.g. | ||
Then create a release by pushing a tag corresponding to the jaegertracing/jaeger version `release-X.Y.0`, e.g. | ||
|
||
```shell | ||
make start-release VERSION=1.12.0 | ||
|
||
# or manually | ||
|
||
git tag release-1.12.0 | ||
git push upstream release-1.12.0 | ||
``` | ||
|
@@ -29,4 +33,3 @@ TODO: shouldn't the tag only specify major/minor, not patch? I don't think the p | |
### Auto-generated documentation for CLI flags | ||
|
||
The docs for the Jaeger CLI tools are generated by the automated release process described above using the Python script [`scripts/gen-cli-data.py`](./scripts/gen-cli-data.py). It uses the configuration file `data/cli/next-release/config.json` (automatically copied to `data/cli/${NEXT_VERSION}/config.json`) that describes which Jaeger binaries to include in the documentation, and which storage options each binary supports. The script invokes the `docs` command on the respective Docker images for each binary and creates a set of YAML files under `data/cli/${NEXT_VERSION}/`, which are then used by the template engine to render the CLI docs. | ||
|