Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

packaging: updating docs on cpack usage to include Chocolatey #6022

Merged
merged 2 commits into from
Jun 23, 2020
Merged

packaging: updating docs on cpack usage to include Chocolatey #6022

merged 2 commits into from
Jun 23, 2020

Conversation

muffins
Copy link
Contributor

@muffins muffins commented Nov 9, 2019 •
edited

Summary:

This updates the docs around using cpack to build packages for
Windows, Linux, and macos.

Tests:

See pictures of updated docs in markdown:
image

@muffins muffins mentioned this pull request Nov 9, 2019
Closed
@Smjert
Copy link
Member

Smjert commented Nov 9, 2019 •
edited

Thank you for looking into this.
"Building" the package target should already select the correct cpack afaik, and it works on all the platforms, it's not a Linux only thing.

Maybe we can fix that section and also add your part where we show that cpack can be called in a second moment.
The main difference between the two ways is that using the package target should rebuild anything that went out of date; calling cpack only will instead generate the package with what's in the build folder in that moment.

I also wonder if it makes sense doing a separate page, because the building.md start to feel a bit long and packaging is not really building.

@muffins
Copy link
Contributor Author

muffins commented Nov 12, 2019

"Building" the package target should already select the correct cpack afaik, and it works on all the platforms, it's not a Linux only thing.

Ah gotcha! My intent with this PR, and the one coming behind it, was just to enable us the option to output a Chocolatey package for uploading to the Choco repos, as opposed to using the one-off scripts I've been clung to for years.

As for the placement, I was mostly just trying to fix the broken rendering for the descriptions of cpack:

Screen Shot 2019-11-12 at 9 43 25 AM

I'll take a crack at re-arranging things to see if I can make it make more sense. I'd agree that for most folks they should just target building the package target, this was more just for the osquery tag deployments. I think perhaps cutting a new doc around packaging might make sense, do we prefer this to exist under deployment or development alongside building the custom packages? Imo packaging is more of a deployment thing, as opposed to development, but maybe it's better to keep the build step close to the package step?

@theopolis theopolis mentioned this pull request Dec 10, 2019
Merged
@muffins
Copy link
Contributor Author

muffins commented Dec 10, 2019

@Smjert @theopolis I took another crack at this verbiage. Mind taking another look?

@theopolis
Copy link
Member

I don’t understand why we need to elaborate on using cpack directly?

@theopolis
Copy link
Member

@muffins do we still need this?

@muffins muffins force-pushed the fix-5996-cpack-instructions branch from f88497c to ec2fab2 Compare June 7, 2020 03:48
@muffins muffins changed the title packaging: updating docs on cpack usage for Windows and macos packaging: updating docs on cpack usage to include Chocolatey Jun 7, 2020
@theopolis @muffins
docs: Fix custom package markdown (osquery#6110)
eafbbc3 
Co-Authored-By: Nick Anderson <nanderson7@gmail.com>
@muffins muffins force-pushed the fix-5996-cpack-instructions branch from ec2fab2 to eafbbc3 Compare June 7, 2020 03:50
@muffins
Copy link
Contributor Author

muffins commented Jun 7, 2020

@theopolis I think so, I've re-purposed this a bit to largely just include the instructions for toggling the Windows build between Chocolatey and MSI. Lemme know what you think. I can reduce/add whatever is needed but I think the changes a bit more minimal than they were before.

@muffins muffins merged commit d6e7b25 into osquery:master Jun 23, 2020
aikuchin pushed a commit to aikuchin/osquery that referenced this pull request Jul 11, 2023
@OlegOAndreev
Merge pull request osquery#10 in CLOUD/osquery from sync/osquery-4.4.…
7fea62e 
…0 to master

* commit 'eeee0fb0957f5af983f817c2e6f19c53108d9e09': (83 commits)
  Add additional changelog items (osquery#6523)
  Changelog for 4.4.0 (osquery#6492)
  build: Add Azure tables to specs CMakeLists (osquery#6507)
  CMake: Correct macOS framework linking (osquery#6522)
  tables: Only populate table cache with star-like selects (osquery#6513)
  CMake: Fix and cleanup compile flags (osquery#6521)
  docs: Add note to bump the Homebrew cask (osquery#6519)
  tests: Fix atom_packages, processes, rpm_packages flakiness (osquery#6518)
  bug: Do not use system proxy for AWS local authority (osquery#6512)
  packaging: updating docs on cpack usage to include Chocolatey (osquery#6022)
  bug: Fix typed_row table caching (osquery#6508)
  Implement event batching support for Windows tables (osquery#6280)
  http: Use sync resolve (osquery#6490)
  Add support for basic chassis information (osquery#5282)
  Only emit 'denylist' warning once (osquery#6493)
  docs: Remove references to brew in macOS install (osquery#6494)
  Fix for osquery#5890: Event Format Results and the Kafka Logger (osquery#6449)
  make apt_sources table parsing much more resilient (osquery#6482)
  Make file and hash container columns hidden (osquery#6486)
  Update documentation to use 'allow list' and 'deny list' diction (osquery#6489)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@theopolis theopolis theopolis approved these changes

Assignees
No one assigned
Labels
documentation packaging
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@muffins @Smjert @theopolis