empayre/fleet
14
0
Fork 0
mirror of https://github.com/empayre/fleet.git synced 2024-11-06 17:05:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
676f3f0bd5
fleet/docs/4-Contribution/5-Releasing-Fleet.md
noahtalerman 9fb9da31f5
Bring Orbit docs into Fleet docs and add FAQ section (#717) 
- Add new `2-Orbit-osquery/` directory to the top-level `docs/` directory.
- Rename `2-Deployment/` -> `3-Deployment/` to accommodate new Orbit directory.
- Rename `3-Contribution/` ->  `4-Contribution/` to accommodate new Orbit directory.
- Add FAQ section to Orbit documentation.
2021-05-04 15:50:18 -04:00

2.8 KiB
Raw Blame History

Releasing Fleet

  1. Update the CHANGELOG with the changes that have been made since the last Fleet release. Update the NPM package.json with the new version number (do not yet npm publish). Update the Helm chart and values file with the new version number.

Commit these changes via Pull Request and pull the changes on the master branch locally. Check that HEAD of the master branch points to the commit with these changes.

  1. Tag and push the new release in Git:
git tag <VERSION>
git push origin <VERSION>
  1. Build the new binary bundle (ensure working tree is clean because this will effect the version string built into the binary):
make binary-bundle

Make note of the SHA256 checksum output at the end of this build command to paste into the release documentation on GitHub.

  1. Create a new release on the GitHub releases page. Select the newly pushed tag (GitHub should say "Existing tag"). Use the version number as the release title. Use the below template for the release description (replace items in <> with the appropriate values):
### Changes

<COPY FROM CHANGELOG>

### Upgrading

Please visit our [update guide](https://github.com/fleetdm/fleet/blob/master/docs/1-Using-Fleet/7-Updating-Fleet.md) for upgrade instructions.

### Documentation

Documentation for this release can be found at https://github.com/fleetdm/fleet/blob/<VERSION>/docs/README.md

### Binary Checksum

**SHA256**
```
<HASH VALUE>  fleet.zip
<HASH VALUE>  fleetctl.exe.zip
<HASH VALUE>  fleetctl-linux.tar.gz
<HASH VALUE>  fleetctl-macos.tar.gz
<HASH VALUE>  fleetctl-windows.tar.gz
```

Upload fleet.zip, fleetctl-*.tar.gz, and fleetctl.exe.zip. Click "Publish Release".

  1. Push the new version to Docker Hub (ensure working tree is clean because this will effect the version string built into the binary):
make docker-push-release

  1. Publish the new version of fleetctl on NPM. Run npm publish in the fleetctl-npm directory. Note that NPM does not allow replacing a package without creating a new version number. Take care to get things correct before running npm publish!

  2. Announce the release in the #fleet channel of osquery Slack and update the channel's topic with the link to this release. Using @here requires admin permissions, so typically this announcement will be done by @zwass.

Announce the release via blog post (on Medium) and Twitter (linking to blog post).

  1. Crack open a beer and wonder why we haven't yet automated this process. Cheers!