fleet icon indicating copy to clipboard operation
fleet copied to clipboard

Fleetctl package filename override

Open georgekarrv opened this issue 8 months ago • 6 comments

Goal

User story
As a IT admin,
I want to specify the filename when building fleetctl package
so that I can better control where the new package is created.

Key result

None, small UX improvement.

Original requests

Private Slack

Context

  • Product Designer: @georgekarrv
  • Engineer: @georgekarrv

Changes

Product

  • [ ] CLI (fleetctl) usage changes: Add new optional parameter --outfile to specify the path for the new package that gets created
  • [ ] First draft of test plan added
  • [ ] Once shipped, requester has been notified
  • [ ] Once shipped, dogfooding issue has been filed

Engineering

  • [ ] Test plan is finalized

ℹ️  Please read this issue carefully and understand it. Pay special attention to UI wireframes, especially "dev notes".

QA

Risk assessment

  • Requires load testing: No
  • Risk level: Low / High Low

Test plan

Make sure to go through the list and consider all events that might be related to this story, so we catch edge cases earlier.

  • [x] 1. Generate one of each package deb, rpm, msi, pkg in the standard no outfile way
  • [x] 2. Install and verify succsessful enrollment
  • [x] 3. Generate one of each package deb, rpm, msi, pkg with custom filenames
  • [x] 4. Repeat step 2

Testing notes

Confirmation

  1. [ ] Engineer: Added comment to user story confirming successful completion of test plan.
  2. [x] QA: Added comment to user story confirming successful completion of test plan.

georgekarrv avatar May 29 '25 15:05 georgekarrv

Went with --outfile since --output would typically more control the logging that occurs during a command if you wanted to change where the logs go or even the loglevel in some cases

georgekarrv avatar May 29 '25 16:05 georgekarrv

This is more explicit to be the file that this command spits out

georgekarrv avatar May 29 '25 16:05 georgekarrv

Hey @georgekarrv, could you please file a feature request for this story. We just want to be consistent and follow this process.

We are going to prioritize this feature request in the next sprint.

marko-lisica avatar Jun 12 '25 14:06 marko-lisica

I would argue we are stalling over a simple option

If the PR is a quick fix (i.e. typo) or obvious technical improvement that doesn't change the product, it can be merged. I would personally advocate to just merge it ATM (this is too much process over adding an optional name change).

georgekarrv avatar Jun 12 '25 14:06 georgekarrv

QA Testing Notes:

  • Completed the Test Plan
  • Confirmed that --outfile is listed in fleetctl package --help

UX note:

  • @georgekarrv as I was testing I realized that it might be great to include this parameter within the Add Hosts UI to help users learn about this option, similar to how we list out the --arch parameter.
  • I tried adding it locally and will talk to @noahtalerman about it on Friday during our 1:1 intro call to see what he thinks as well
Image

AndreyKizimenko avatar Jun 17 '25 22:06 AndreyKizimenko

UX note:

  • @georgekarrv as I was testing I realized that it might be great to include this parameter within the Add Hosts UI to help users learn about this option, similar to how we list out the --arch parameter.
  • I tried adding it locally and will talk to @noahtalerman about it on Friday during our 1:1 intro call to see what he thinks as well

Chatted with @AndreyKizimenko and decided to leave out the new copy. Why? Less copy is better here so we don't hide the more important flags: architecture and Linux flavor. Also, soon Fleet will replace the fleetctl package dialog with a download button.

noahtalerman avatar Jun 20 '25 17:06 noahtalerman

Hey @pintomi1989, heads up, this was shipped in 4.70.

marko-lisica avatar Jul 23 '25 11:07 marko-lisica

In the cloud city, Admins control package names, Effortless and free.

fleet-release avatar Jul 28 '25 17:07 fleet-release