fossa-cli icon indicating copy to clipboard operation
fossa-cli copied to clipboard

Release group commands

Open JeffreyHuynh1 opened this issue 11 months ago • 0 comments

Overview

The CLI should offer a way to create release groups from the command line. Creating and deleting other org-level objects should be done through their own command.

Acceptance criteria

  • There is a way to create and delete a release group from the CLI.

  • Emit audit logs on release group creation in CORE

Testing plan

example .fossa.yml:

server: http://localhost:9578
apiKey: <Key>
releaseGroup:
  title: example-title
  release: example-release-title
  releaseGroupProjects:
    - projectId: custom+1/[email protected]/example
      projectRevision:   12345 
      projectBranch: main
  licensePolicy: license-policy-name 
  securityPolicy: security-policy-name
  teams:
      - team1
      - team2

Create a release group:

  • fossa release-group create -e http://localhost:9578 --fossa-api-key <KEY> --title example-title --release example-release-title --project-id custom+1/[email protected]/example --project-revision 12345 --project-branch main
  • fossa release-group create -c /path/to/.fossa.yml/

Add projects to a release group:

  • fossa release-group add-projects -e http://localhost:9578 --fossa-api-key <KEY> --title example-title --release example-release-title --project-id custom+1/[email protected]/example --project-revision 12345 --project-branch main
  • fossa release-group add-projects -c /path/to/.fossa.yml/

Delete a release group:

  • fossa release-group delete -e http://localhost:9578 --fossa-api-key <KEY> --title example-title

Delete a release group release:

  • fossa release-group delete-release -e http://localhost:9578 --fossa-api-key <KEY> --title example-title --release example-release-title

Risks

Metrics

References

Checklist

  • [x] I added tests for this PR's change (or explained in the PR description why tests don't make sense).
  • [x] If this PR introduced a user-visible change, I added documentation into docs/.
  • [x] If this PR added docs, I added links as appropriate to the user manual's ToC in docs/README.ms and gave consideration to how discoverable or not my documentation is.
  • [x] If this change is externally visible, I updated Changelog.md. If this PR did not mark a release, I added my changes into an # Unreleased section at the top.
  • [x] If I made changes to .fossa.yml or fossa-deps.{json.yml}, I updated docs/references/files/*.schema.json AND I have updated example files used by fossa init command. You may also need to update these if you have added/removed new dependency type (e.g. pip) or analysis target type (e.g. poetry).
  • [x] If I made changes to a subcommand's options, I updated docs/references/subcommands/<subcommand>.md.

JeffreyHuynh1 avatar Mar 11 '24 11:03 JeffreyHuynh1