https://github.com/osquery/tools
Tools for packaging and signing osquery
https://github.com/osquery/tools
Last synced: 3 months ago
JSON representation
Tools for packaging and signing osquery
- Host: GitHub
- URL: https://github.com/osquery/tools
- Owner: osquery
- Created: 2020-02-19T04:17:47.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T03:28:18.000Z (over 1 year ago)
- Last Synced: 2025-06-11T11:25:25.069Z (7 months ago)
- Language: Go
- Size: 19.5 KB
- Stars: 2
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Tools
Tools for maintaining osquery releases
## Release Notes & Changelog Generation
`cmd/release-notes` is a simple wrapper around github to generate a
CHANGELOG. It uses graphql to cather the list of all commits, and
then examines an existing CHANGELOG file to suggest the omissions.
It categorizes the commits based on simple logic based on the PR labels.
Output will be displayed to stdout.
The expected workflow is to have a clean checkout on a branch ready
for the PR. Run this cmd, take the output, and update the CHANGELOG
file. As you edit and categorize, you can re-run the script to see the
omissions.
The underlying implementation uses timestamps to generate the diff
between the labels, because that's what git supports.
### How to use
This is written in `go` and you will need the go tool chain installed.
It may be run in place with a command like:
``` shell
go run ./cmd/release-notes --help
```
As an example:
``` shell
export GITHUB_TOKEN=`gh config get -h github.com oauth_token`
go run ./cmd/release-notes --changelog ~/checkouts/osquery/osquery/CHANGELOG.md --last 5.12.1 --new 5.12.2
```