chore: [Policy Assistant] rename Cyclonus to policy-assistant

[huntergregory]

New Binary Name

• Fixes [Policy Assistant] update binary names to policy-assistant instead of cyclonus #254

$ cd cmd/policy-assistant
$ make policy-assistant
$ ./cmd/policy-assistant/policy-assistant analyze --help
...

Used to be:

$ make cyclonus
$ ./cmd/cyclonus/cyclonus analyze --help
...

New Module Name

• Fixes [Policy Assistant] use internal vendoring instead of vendoring from Cyclonus #170

module sigs.k8s.io/network-policy-api/policy-assistant

Used to be:

module github.com/mattfenwick/cyclonus

Docs Update

• Adds some READMEs
• Moves outdated Cyclonus docs/examples to archived/ folders

Add go vet and go fmt checks to GH action

Outputs for go fmt

• If there's a file that needs formatting:
  • 
• Otherwise:
  • 

[netlify]

✅ Deploy Preview for kubernetes-sigs-network-policy-api ready!

Name	Link
🔨 Latest commit	ac44f11
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-sigs-network-policy-api/deploys/672c499c8b49870008f0dbc8
😎 Deploy Preview	https://deploy-preview-262--kubernetes-sigs-network-policy-api.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[huntergregory]

This will fail with non-zero exit code if go vet detects a problem

[huntergregory]

@aojea or @danwinship could you approve the changes to the Github action? And add a lgtm? Thanks!

[huntergregory]

See #263

[huntergregory]

fyi @mattfenwick this PR changes the name from Cyclonus to something else like you suggested some time ago

[from #62]
rename to something appropriate for kubernetes-sigs (positive side effect: disambiguates from my personal project)

I'm thinking to change cyclonus binary to pola per thoughts in #255

[danwinship]

/approve
for the workflow changes. It would really be good to get someone else to lgtm the policy agent changes...

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: danwinship, huntergregory

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [danwinship]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[huntergregory]

Renaming binary from cyclonus:

I'd be inclined to name the CLI pola since it seems CLIs are usually short/abbreviated for less typing. Currently the binary is located at cmd/policy-assistant/cmd/cyclonus/cyclonus.

New Binary Name

Fixes #254

$ cd cmd/policy-assistant
$ make pola
$ ./cmd/pola/pola analyze --help
...

Used to be:

$ make cyclonus
$ ./cmd/cyclonus/cyclonus analyze --help
...

[huntergregory]

Renaming go module from cyclonus:

idea for new name: sigs.k8s.io/network-policy-api/policy-assistant

NOTE: this would drop the cmd/ directory (pola is located at cmd/policy-assistant/)

New Module Name

Fixes #170

module sigs.k8s.io/network-policy-api/policy-assistant

Used to be:

module github.com/mattfenwick/cyclonus

[tssurya]

+1 to rename it to policy-assistant from cyclonus @mattfenwick any concerns? (I unfortunately have not reviewed the PR yet just wanted to say I am ok with the name change in response to https://kubernetes.slack.com/archives/C01CWSHQWQJ/p1730829759640629)

[tssurya]

I am also OK to call the CLI pola and tags pola, its just the dumb me couldn't connect pola as the short abbreviation for policy-assistant ; but I am not sure if that is common in API/CLI usually? We usually always go with long abbreviations and add a short-name alias sorta thing for that long name... but maybe this is OK?

[huntergregory]

Thanks for the feedback @tssurya . As some context, Gateway API names their CLI for user tooling gwctl. It seems like their project name is "gwctl" as well though?

[huntergregory]

I'm convinced that pola isn't a great idea after Surya's feedback above and Mike's feedback offline, where he echoed how it wasn't immediately clear what pola meant. Regarding abbreviations / more typing, Mike also shared how devs frequently write their own aliases like k for kubectl.

I feel like policy-assistant is a decent name for the static analysis tool. And the project is already called policy assistant, so it makes for a nicer user experience if the project name is the same as the binary name. Updating the PR now to replace pola with policy-assistant

[npinaeva]

/lgtm

[tssurya]

Yea policy-assisstant ++
pola wasn't intuitive enough
Thanks @huntergregory