Develop Github Action that uses the CLI

[wezell]

Parent Issue

CLI Phase 2
#24753

User Story

I am a dotCMS developer and I want to set up a CI/CD pipeline from github using github actions. As a developer, I should be able to commit my files, code changes and fixes into git and see them reflected in my dotCMS environment.

• If I add a new site, I should see that site created in dotCMS
• If I commit a new content type, I should see that reflected - same with css, js, VTLs, files and folders, file containers and file templates.
• If I change a content type, it should be changed in the target environment.
• If I change a content type, vtl or asset, it should be updated in the target environment as well.

Acceptance Criteria

• The action will generally be triggered by a workflow that is fired when a new commit/merge happens in a branch

• The action will be built as a Docker container action (see: https://docs.github.com/en/actions/creating-actions/creating-a-docker-container-action)

• The action's Dockerfile should be stored in the /tools/dotcms-cli/action/

• The action will take env variables to configure it

  • The target dotCMS env
  • dotCMS API Token, provided as a github secret
  • any cli config flags
  • should destructive actions be taken - whether to support deletes and take destructive actions (folder, content type, file deletions)

• As we add new features to the CLI, we should also make sure our github action will support them.

Proposed Objective

Technical User Experience

Proposed Priority

Priority 2 - Important

Tasks

Preview Give feedback

1. RESEARCH: Evaluate what is required to send from the GHA to the entrypoint.sh #25821
   QA : Not Needed Team : Scout Type : Task +3
2. Implement a "super push" command to sync the files from to repo to the target dotcms env #25822
   Merged QA : Approved QA : Passed Internal Release : 24.01.26 Team : Scout Type : Task dotCMS : CLI +7
3. Create dockerfile and entrypoint.sh that invokes "super push" command #25823
   Merged QA : Not Needed Team : Scout Type : Task +4
4. Create and configure a docker container action to invoke the CLI #25824
   Merged QA : Not Needed Team : Scout Type : Task +4
5. Modify Login command to support token authentication #26000
   Merged QA : Not Needed Team : Scout Type : Task +4
6. Implement "sync" feature for content types #26001
   Merged QA : Approved QA : Passed Internal Release : 24.01.26 Team : Scout Type : Task dotCMS : CLI +7
7. Implement "sync" feature for languages #26002
   Merged NW Removed Note to QA QA : Approved QA : Passed Internal Release : 24.02.20 Team : Scout Type : Task dotCMS : CLI +9
8. Implement "sync" feature for sites #26003
   Merged QA : Approved QA : Passed Internal Release : 24.01.26 Team : Scout Type : Task dotCMS : CLI +7
9. CLI: Create a GHA that invokes the CLI #26300
   Merged Note to QA QA : Approved QA : Passed Internal Release : 24.02.20 Team : Scout Type : Task dotCMS : CLI +8
10. CLI: Allow custom param configuration in the GHA #26386
    Merged QA : Approved QA : Passed Internal Release: 24.03.11 Team : Scout Type : New Functionality dotCMS : CLI +7