Skip to content

GitHub Action to publish Docs.#461

Merged
alexheifetz merged 2 commits intomainfrom
docs-workflow
Jun 9, 2025
Merged

GitHub Action to publish Docs.#461
alexheifetz merged 2 commits intomainfrom
docs-workflow

Conversation

@alexheifetz
Copy link
Contributor

This pull request introduces a new GitHub Actions workflow for deploying documentation to a virtual machine and removes redundant steps from an existing Maven build workflow. The changes streamline the build process and enable automated deployment of generated documentation.

New Workflow for Documentation Deployment:

  • .github/workflows/deploy-docs.yml: Added a new workflow named "Publish Docs" that builds documentation using Maven and deploys it to a specified VM instance. The workflow includes steps for setting up Java, installing Graphviz for PlantUML diagrams, authenticating with Google Cloud, and deploying files to the VM. It supports manual triggering with configurable inputs for environment, VM instance name, and zone.

Streamlining Maven Workflow:

  • .github/workflows/maven.yml: Removed the step for installing Graphviz, as it is now part of the new documentation deployment workflow. This reduces redundancy in the Maven build process.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Jun 8, 2025

@alexheifetz alexheifetz marked this pull request as ready for review June 9, 2025 01:32
@alexheifetz alexheifetz changed the title Docs workflow Add GitHub Action to publish Docs. Jun 9, 2025
@alexheifetz alexheifetz changed the title Add GitHub Action to publish Docs. GitHub Action to publish Docs. Jun 9, 2025
@alexheifetz alexheifetz merged commit cc5131a into main Jun 9, 2025
4 checks passed
@alexheifetz alexheifetz deleted the docs-workflow branch June 9, 2025 01:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant