Abbot – deploy for Slack by Serious Business

Code

<br /> /*<br /> Description: Manage deployments with the GitHub Deployment API</p> <p>Package URL: /packages/aseriousbiz/deploy</p> <p>USAGE:</p> <p>Manage GitHub deployments to deployment targets. A deployment target is a named environment such as ‘stage’, ‘prod’, etc.<br /> * `@abbot deploy status [for {owner}/{repo}]` – List the status of most recent deployments.<br /> * `@abbot deploy repo` – Displays the default repository for this room.<br /> * `@abbot deploy repo {owner}/{repo}` – Sets the default repo for this room.<br /> * `@abbot deploy list targets` – Lists available deployment targets.<br /> * `@abbot deploy add target {target}` – Adds a deployment target.<br /> * `@abbot deploy remove target {target}` – Removes a deployment target.<br /> * `@abbot deploy {branch or SHA} to {target} [for {owner}/{repo}]` – Creates a GitHub deployment of branch/SHA to a deployment target. To force a deploy add `–forced` at the very end.<br /> Note: You can specify a default repository for a room using `@abbot repo {owner}/{repo}`. that way you don’t have to append each status command with `for {owner}/{repo}`.</p> <p>GitHub Deploy skill was inspired by https://github.com/stephenyeargin/hubot-github-deployments<br /> */<br /> using Octokit;</p> <p>var githubToken = await Bot.Secrets.GetAsync(“GitHubToken”);</p> <p>if (githubToken is not {Length: > 0}) {<br /> await Bot.ReplyAsync(“This skill requires a GitHub Developer Token set up as a secret. ”<br /> + “Visit https://github.com/settings/tokens to create a token. ”<br /> + $”Then visit {Bot.SkillUrl} and click \”Manage skill secrets\” to add a secret named `GitHubToken` with the token you created at GitHub.com.”);<br /> return;<br /> }</p> <p>var (forceArg, args) = Bot.Arguments.FindAndRemove(args => args.Value.Equals(“–force”, StringComparison.OrdinalIgnoreCase));</p> <p>if (args is { Count: 0 }) {<br /> await ReplyWithUsage();<br /> return;<br /> }</p> <p>// For GitHub Enterprise, pass in the Base URL after the ProductHeaderValue argument.<br /> var github = new GitHubClient(new ProductHeaderValue(“Abbot”)) {<br /> Credentials = new Credentials(githubToken)<br /> };</p> <p>var (cmd, subject, preposition, ownerAndRepo) = args;</p> <p>if (cmd.Value is “repo”) {<br /> if (subject is IMissingArgument) {<br /> var repo = await GetDefaultRepository();<br /> if (repo is not null) {<br /> await Bot.ReplyAsync($”The default repository for this room is `{repo}`.”);<br /> }<br /> else {<br /> await Bot.ReplyAsync($”No default repository is set for this room. Use `{Bot} {Bot.SkillName} repo {{owner}}/{{name}}` to set the repository.”);<br /> }<br /> }<br /> else {<br /> var repo = subject.Value;<br /> await SetDefaultRepository(repo);<br /> await Bot.ReplyAsync($”I set the default repo for this room to `{repo}`.”);<br /> }<br /> return;<br /> }</p> <p>if (cmd.Value is “status”) {<br /> var deploymentId = subject.ToInt32();<br /> var repoArg = deploymentId is null<br /> ? ownerAndRepo<br /> : preposition;</p> <p> var (owner, repo) = await GetOwnerAndRepo(repoArg);<br /> if (repo is null) {<br /> return;<br /> }</p> <p> if (deploymentId is not null) {<br /> var statuses = await github.Repository.Deployment.Status.GetAll(owner, repo, deploymentId.Value);<br /> if (statuses is { Count: 0 }) {<br /> await Bot.ReplyAsync(“No statuses available”);<br /> return;<br /> }<br /> await Bot.ReplyAsync(statuses.Select(status => $”Status: {status.Description} ({status.CreatedAt}) / State: #{status.State}”)<br /> .ToMarkdownList());<br /> }<br /> else {<br /> var deployments = await github.Repository.Deployment.GetAll(owner, repo);<br /> if (deployments is { Count: 0 }) {<br /> await Bot.ReplyAsync(“No recent deploymments.”);<br /> return;<br /> }<br /> await Bot.ReplyAsync(<br /> deployments.Select(deployment => $”Deployment {deployment.Id} ({deployment.CreatedAt}): User: {deployment.Creator.Login} / Action: Deploy / Ref: {deployment.Sha} / Description: (#{deployment.Description})”)<br /> .ToMarkdownList());<br /> }<br /> return;<br /> }</p> <p>if (cmd.Value is “list”) {<br /> if (subject.Value is “targets”) {<br /> var targets = await GetDeploymentTargets();<br /> if (targets.Count is 0) {<br /> await Bot.ReplyAsync($”No deployment targets. `{Bot} {Bot.SkillName} add target {{target}}` to add a deployment target.”);<br /> return;<br /> }<br /> await Bot.ReplyAsync(targets.ToMarkdownList());<br /> }<br /> else if (subject.Value is “branches”) {<br /> var (owner, repo) = await GetOwnerAndRepo(ownerAndRepo);<br /> if (repo is null) {<br /> return;<br /> }<br /> var branches = await github.Repository.Branch.GetAll(owner, repo);<br /> await Bot.ReplyAsync(branches.Select(branch => $”{branch.Name}: {branch.Commit.Sha}”).ToMarkdownList());<br /> }<br /> else {<br /> await Bot.ReplyAsync($”I can list `targets` and `branches`. Use `{Bot} help {Bot.SkillName}` for more details.”);<br /> }<br /> return;<br /> }</p> <p>if (cmd.Value is “add” && subject.Value is “target”) {<br /> if (preposition is IMissingArgument) {<br /> await Bot.ReplyAsync(“Please specify a deployment target to add.”);<br /> return;<br /> }<br /> var target = preposition.Value;<br /> await AddDeploymentTarget(target);<br /> await Bot.ReplyAsync($”Added {target} to the set of deployment targets.”);<br /> return;<br /> }</p> <p>if (subject.Value is “to”) {<br /> // Handle deployment<br /> var reference = cmd.Value;<br /> var target = preposition.Value;<br /> var targets = await GetDeploymentTargets();<br /> if (!targets.Contains(target)) {<br /> await Bot.ReplyAsync($”{target} is not in the available deployment targets. Use `{Bot} {Bot.SkillName} list targets`.”);<br /> return;<br /> }<br /> var (owner, repo) = await GetOwnerAndRepo(ownerAndRepo);<br /> if (repo is null) {<br /> return;<br /> }<br /> var deployment = new NewDeployment(reference) {<br /> Environment = target,<br /> Task = DeployTask.Deploy,<br /> Payload = new() {<br /> {“user”, Bot.From.Name },<br /> {“room”, Bot.Room.Name },<br /> {“skill”, Bot.SkillName },<br /> },<br /> Description = $”{Bot.From.Name} deployed `{reference}` to `{target}`”<br /> };</p> <p> var force = forceArg is not IMissingArgument;<br /> if (force) {<br /> await Bot.ReplyAsync(“Forced? I hope you know what you’re doing…”);<br /> deployment.RequiredContexts = new System.Collections.ObjectModel.Collection<string>();<br /> }</p> <p> await Bot.ReplyAsync($”Creating deployment for ref {reference} to env: {target} for {owner}/{repo}.”);<br /> var result = await github.Repository.Deployment.Create(owner, repo, deployment);<br /> await Bot.ReplyAsync(result.Description);<br /> return;<br /> }</p> <p>string roomKey = Bot.Room.Id ?? Bot.Room.Name;</p> <p>async Task<string> GetDefaultRepository() {<br /> return await Bot.Brain.GetAsync($”{roomKey}_Repo”);<br /> }</p> <p>Task SetDefaultRepository(string repo) {<br /> return Bot.Brain.WriteAsync($”{roomKey}_Repo”, repo);<br /> }</p> <p>async Task<HashSet<string>> GetDeploymentTargets() {<br /> return await Bot.Brain.GetAsync($”{roomKey}_Targets”) ?? new HashSet<string>();<br /> }</p> <p>async Task AddDeploymentTarget(string target) {<br /> var targets = await GetDeploymentTargets();<br /> targets.Add(target);<br /> await SaveDeploymentTargets(targets);<br /> }</p> <p>async Task RemoveDeploymentTarget(string target) {<br /> var targets = await GetDeploymentTargets();<br /> targets.Remove(target);<br /> await SaveDeploymentTargets(targets);<br /> }</p> <p>Task SaveDeploymentTargets(HashSet<string> targets) {<br /> return Bot.Brain.WriteAsync($”{roomKey}_Targets”, targets);<br /> }</p> <p>async Task<(string, string)> GetOwnerAndRepo(IArgument argument) {<br /> var (owner, repo) = ((string)null, (string)null);<br /> if (argument is IMissingArgument) {<br /> var ownerAndRepo = await GetDefaultRepository();<br /> if (ownerAndRepo is null) {<br /> await Bot.ReplyAsync($”No default repository is set for this room. Use `{Bot} {Bot.SkillName} repo {{owner}}/{{name}}` to set the repository.”);<br /> return (owner, repo);<br /> }<br /> (owner, repo) = SplitOwnerAndRepo(ownerAndRepo);<br /> }<br /> else if (argument is IArguments arguments and {Count: 2}) {<br /> (owner, repo) = SplitOwnerAndRepo(arguments[1].Value);<br /> }<br /> else {<br /> (owner, repo) = SplitOwnerAndRepo(argument.Value);<br /> }<br /> if (owner is not { Length: > 0 } && repo is not { Length: > 0 }) {<br /> await Bot.ReplyAsync($”Please specify an owner/repo (use `{Bot} help {Bot.SkillName}` for more details) or set a default repo for this room with `{Bot} repo {{owner}}/{{repo}}`”);<br /> return (null, null);<br /> }<br /> return (owner, repo);<br /> }</p> <p>static (string, string) SplitOwnerAndRepo(string ownerAndRepo) {<br /> var arry = ownerAndRepo.Split(‘/’);</p> <p> if (arry.Length != 2) {<br /> return (null, null);<br /> }<br /> return (arry[0], arry[1]);<br /> }</p> <p>async Task ReplyWithUsage() {<br /> var usage = $@”`{Bot} help {Bot.SkillName}` to get help using this skill.”;<br /> await Bot.ReplyAsync(usage);<br /> }<br />