Adapt bootstrap and autodeploy commands to GitHub Actions #979
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,6 +2,7 @@ | |
|
|
||
| namespace RoboComponents; | ||
|
|
||
| use Robo\Symfony\ConsoleIO; | ||
| use Symfony\Component\Yaml\Yaml; | ||
|
|
||
| /** | ||
|
|
@@ -693,24 +694,21 @@ public function deployPantheonInstallEnv(string $env = 'qa', ?string $pantheon_n | |
| } | ||
|
|
||
| /** | ||
| * Configures automatic deployment to Pantheon using GitHub Actions. | ||
| * | ||
| * This command generates an SSH key pair and provides instructions for | ||
| * setting up the necessary GitHub Secrets and Variables for automatic | ||
| * deployment. | ||
| * | ||
| * @param string $token | ||
| * Terminus machine token: https://pantheon.io/docs/machine-tokens. | ||
| * @param string $github_token | ||
| * Personal GitHub token: | ||
| * https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token. | ||
| * | ||
| * @throws \Exception | ||
| */ | ||
| public function deployConfigAutodeploy(string $token, string $github_token): void { | ||
| $pantheon_info = $this->getPantheonNameAndEnv(); | ||
| $project_name = $pantheon_info['name']; | ||
|
|
||
|
|
@@ -720,63 +718,137 @@ public function deployConfigAutodeploy(string $token, string $github_token, stri | |
| throw new \Exception('The key generation failed.'); | ||
| } | ||
|
|
||
| $result = $this->taskExec("terminus connection:info $project_name.dev --fields='Git Command' --format=string | awk '{print $3}'") | ||
| ->printOutput(FALSE) | ||
| ->run(); | ||
| $pantheon_git_url = trim($result->getMessage()); | ||
|
|
||
| $this->say("The project was prepared for automatic deployment to Pantheon using GitHub Actions"); | ||
| $this->say(""); | ||
|
|
||
| // Check if gh CLI is available. | ||
| $gh_available = $this->taskExec('which gh') | ||
| ->printOutput(FALSE) | ||
| ->run() | ||
| ->wasSuccessful(); | ||
|
|
||
| // If gh CLI is not available, try to install it. | ||
| if (!$gh_available) { | ||
| $this->say("GitHub CLI (gh) is not installed. Installing it now..."); | ||
|
|
||
| // Install gh CLI on Ubuntu/Debian. | ||
| $install_commands = [ | ||
| 'sudo apt-get update -qq', | ||
| 'sudo apt-get install -y -qq curl', | ||
| 'curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg 2>/dev/null', | ||
| 'sudo chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg', | ||
| 'echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null', | ||
| 'sudo apt-get update -qq', | ||
| 'sudo apt-get install -y -qq gh', | ||
| ]; | ||
|
|
||
| $install_failed = FALSE; | ||
| foreach ($install_commands as $cmd) { | ||
| $result = $this->taskExec($cmd)->run(); | ||
| if (!$result->wasSuccessful()) { | ||
| $this->say("Warning: Failed to install gh CLI automatically."); | ||
| $install_failed = TRUE; | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| if (!$install_failed) { | ||
| $this->say("✓ GitHub CLI installed successfully!"); | ||
| $this->say(""); | ||
| $gh_available = TRUE; | ||
| } | ||
| } | ||
|
|
||
| if ($gh_available) { | ||
|
Member
There was a problem hiding this comment. @copilot This is not enough. We are inside DDEV, we can sudo and install
Contributor
Author
There was a problem hiding this comment. Done in commit 9dca072. The command now automatically installs gh CLI using sudo if it's not found in the DDEV environment. Installation uses apt with quiet flags to minimize output noise. If installation fails, it falls back to manual instructions. |
||
| $this->say("GitHub Secrets and Variables can be set automatically using gh CLI."); | ||
| $io = new ConsoleIO($this->input(), $this->output()); | ||
| $automate = $io->confirm('Would you like to automatically set up GitHub Secrets and Variables now?', TRUE); | ||
|
|
||
| if ($automate) { | ||
| $this->say(""); | ||
| $this->say("Setting up GitHub Secrets and Variables..."); | ||
|
|
||
| // Set secrets. | ||
| $result = $this->taskExec("gh secret set TERMINUS_TOKEN --body '$token' --repo " . self::$githubProject)->run(); | ||
| if ($result->wasSuccessful()) { | ||
| $this->say("✓ Set TERMINUS_TOKEN secret"); | ||
| } | ||
|
|
||
| $result = $this->taskExec("gh secret set PANTHEON_DEPLOY_KEY < pantheon-key --repo " . self::$githubProject)->run(); | ||
| if ($result->wasSuccessful()) { | ||
| $this->say("✓ Set PANTHEON_DEPLOY_KEY secret"); | ||
| } | ||
|
|
||
| $result = $this->taskExec("gh secret set GH_TOKEN --body '$github_token' --repo " . self::$githubProject)->run(); | ||
| if ($result->wasSuccessful()) { | ||
| $this->say("✓ Set GH_TOKEN secret"); | ||
| } | ||
|
|
||
| // Set variables. | ||
| $result = $this->taskExec("gh variable set PANTHEON_GIT_URL --body '$pantheon_git_url' --repo " . self::$githubProject)->run(); | ||
| if ($result->wasSuccessful()) { | ||
| $this->say("✓ Set PANTHEON_GIT_URL variable"); | ||
| } | ||
|
|
||
| $this->say(""); | ||
| $this->say("GitHub Secrets and Variables have been configured!"); | ||
| $this->say(""); | ||
| $this->say("Optional: You can also set ROLLBAR_SERVER_TOKEN and DEPLOY_EXCLUDE_WARNING variables if needed:"); | ||
| $this->say(" gh variable set ROLLBAR_SERVER_TOKEN --body 'your-token' --repo " . self::$githubProject); | ||
| $this->say(" gh variable set DEPLOY_EXCLUDE_WARNING --body 'warning1|warning2' --repo " . self::$githubProject); | ||
| } | ||
| else { | ||
| $this->printManualInstructions($token, $github_token, $pantheon_git_url); | ||
| } | ||
| } | ||
| else { | ||
| $this->say(""); | ||
| $this->printManualInstructions($token, $github_token, $pantheon_git_url); | ||
| } | ||
|
|
||
| $this->say(""); | ||
| $this->say("Remaining steps:"); | ||
| $this->say("1. Add the SSH public key to the Pantheon account:"); | ||
| $this->say(" - Key location: pantheon-key.pub"); | ||
| $this->say(" - Instructions: https://pantheon.io/docs/ssh-keys"); | ||
| $this->say(""); | ||
| $this->say("2. IMPORTANT: Keep the pantheon-key file secure and DO NOT commit it to the repository."); | ||
| $this->say(" After adding the public key to Pantheon, you can delete the pantheon-key files locally."); | ||
| $this->say(""); | ||
| $this->say("3. Ensure nested docroot is configured: https://pantheon.io/docs/nested-docroot"); | ||
| $this->say(""); | ||
| $this->say("For more details, see the 'Automatic Deployment to Pantheon' section in README.md"); | ||
| } | ||
|
|
||
| /** | ||
| * Prints manual instructions for setting up GitHub Secrets and Variables. | ||
| * | ||
| * @param string $token | ||
| * The Terminus token. | ||
| * @param string $github_token | ||
| * The GitHub token. | ||
| * @param string $pantheon_git_url | ||
| * The Pantheon Git URL. | ||
| */ | ||
| protected function printManualInstructions(string $token, string $github_token, string $pantheon_git_url): void { | ||
| $this->say("Please complete the following steps manually:"); | ||
| $this->say(""); | ||
| $this->say("1. Set up the following GitHub Secrets:"); | ||
| $this->say(" - Go to: Settings → Secrets and variables → Actions → Secrets → New repository secret"); | ||
|
Member
There was a problem hiding this comment. @copilot Can we automate it with
Contributor
Author
There was a problem hiding this comment. Yes! Added gh CLI automation in commit 82479da. The command now:
The gh CLI can be installed on-demand in DDEV, and users will be prompted to confirm before any secrets are set. |
||
| $this->say(" - TERMINUS_TOKEN: " . $token); | ||
| $this->say(" - PANTHEON_DEPLOY_KEY: (paste the contents of pantheon-key file)"); | ||
| $this->say(" - GH_TOKEN: " . $github_token); | ||
| $this->say(""); | ||
| $this->say("2. Set up the following GitHub Variables:"); | ||
| $this->say(" - Go to: Settings → Secrets and variables → Actions → Variables → New repository variable"); | ||
| $this->say(" - PANTHEON_GIT_URL: " . $pantheon_git_url); | ||
| $this->say(" - ROLLBAR_SERVER_TOKEN: (your Rollbar token, optional)"); | ||
| $this->say(" - DEPLOY_EXCLUDE_WARNING: (warnings to exclude, optional)"); | ||
| } | ||
|
|
||
| /** | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This (gh check and init) should be in a helper function, to keep
deployConfigAutodeploymore readable. refactor accordingly