Skip to content

Commit

Permalink
Add release step to update file_format in examples (#149)
Browse files Browse the repository at this point in the history
  • Loading branch information
jack-berg authored Dec 10, 2024
1 parent 1c17b1f commit 1645262
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
7 changes: 7 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,13 @@ generate-descriptions:
npm run-script generate-descriptions -- $(shell pwd)/examples/$$f $(shell pwd)/examples/$$f || exit 1; \
done

.PHONY: update-file-format
update-file-format:
@echo "Updating \"file_format:\" in ./examples/* to: $(FILE_FORMAT)"
@for f in $(EXAMPLE_FILES); do \
sed -e 's/file_format:.*/file_format: \"$(FILE_FORMAT)\"/g' -i '' ./examples/$$f; \
done

.PHONY: install-tools
install-tools:
npm install
Expand Down
12 changes: 12 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# How to Create a Release of OpenTelemetry Configuration (for Maintainers Only)

## Update `file_format`

Update the `file_format: "<verison>` of [./examples](./examples) as follows:

```shell
# Set FILE_FORMAT env var to target version of the release
export FILE_FORMAT=0.4
make update-file-format
```

Merge a PR with the changes to `main`.

## Tagging the Release

Our release tags follow the convention `v<major>.<minor>.<patch>`. For example,
Expand Down

0 comments on commit 1645262

Please sign in to comment.