Skip to content

Deployment task is arbitrary string value#2413

Merged
nickfloyd merged 1 commit intooctokit:mainfrom
mryanmurphy:deployment-task-string
Jul 13, 2022
Merged

Deployment task is arbitrary string value#2413
nickfloyd merged 1 commit intooctokit:mainfrom
mryanmurphy:deployment-task-string

Conversation

@mryanmurphy
Copy link
Contributor

  • Changed NewDeployment Task property to string
  • Added string Task property to Deployment response
  • Updated tests

Changes here align the project to the intended usage based on the documentation linked below.

The task parameter is used by the deployment system to allow different execution paths. In the web world this might be deploy:migrations to run schema changes on the system. In the compiled world this could be a flag to compile an application with debugging enabled.

https://docs.github.com/en/rest/reference/deployments#create-a-deployment

Fixes #2412

@nickfloyd
Copy link
Contributor

Hey @mryanmurphy thank you for posting this, detailing the change, and making the contribution here ❤️ ! I am marking this as a breaking change just so that we can call it out in the release notes - technically this change shouldn't be problematic but since the type/representation has changed on the field I'd like to call that out... just giving you a head's up.

@nickfloyd nickfloyd merged commit 0e469a9 into octokit:main Jul 13, 2022
@mryanmurphy mryanmurphy deleted the deployment-task-string branch July 13, 2022 18:20
@nickfloyd
Copy link
Contributor

release_notes: [Breaking change] Updates the NewDeployment Task property from the DeployTask enum to string - via REST API docs

@nickfloyd nickfloyd added Type: Breaking change Used to note any change that requires a major version bump Type: Feature New feature or request and removed category: breaking-change labels Oct 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Type: Breaking change Used to note any change that requires a major version bump Type: Feature New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DeployTask should be a string, not an enum

2 participants