Skip to content

Commit

Permalink
Document updates (#302)
Browse files Browse the repository at this point in the history
Signed-off-by: Corbin Phelps <[email protected]>
  • Loading branch information
Corbin Phelps authored Mar 22, 2022
1 parent 870f903 commit 771dc6e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# observIQ OpenTelemetry Collector

The observIQ OpenTelemetry Collector is observIQ's distribution of the OpenTelemetry Collector. It provides everything you need to get setup and sending logs to
[observIQ](https://observiq.com/).
The observIQ OpenTelemetry Collector is observIQ's distribution of the OpenTelemetry Collector.

## Installation

Expand Down Expand Up @@ -44,13 +43,13 @@ Clone this repository, and run `make install-tools`

### Building

To create a build for your current machine, run `make agent_manager`
To create a build for your current machine, run `make collector`

To build for a specific architecture, see the [Makefile](./Makefile)

To build all targets, run `make build-all`

Build files will show up in the `./build` directory
Build files will show up in the `./dist` directory

### Running CI checks locally

Expand Down
9 changes: 4 additions & 5 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
# Releasing
Releases are managed through GitHub releases. The steps to create a release are as follows:

1. Update CHANGELOG.md with changes
1. Create a new tag (not release)

2. Create a new tag (not release)

3. The CD job will run for the tagged commit. Goreleaser will handle the following without user intervention:
2. The CD job will run for the tagged commit. Goreleaser will handle the following without user intervention:
- Build the binaries
- Create GitHub release with automatic changelog content (based on commit message)
- Attach binaries to the GitHub release
- Mark the release as a full release once it is finished.
- Create a CHANGELOG

4. Done! The collector is released
3. Done! The collector is released

# Testing Release locally

Expand Down

0 comments on commit 771dc6e

Please sign in to comment.