Skip to content

feat: Github deployment description support#513

Merged
nwtgck merged 1 commit intonwtgck:developfrom
scopsy:feature/github-description
Apr 26, 2021
Merged

feat: Github deployment description support#513
nwtgck merged 1 commit intonwtgck:developfrom
scopsy:feature/github-description

Conversation

@scopsy
Copy link
Copy Markdown
Contributor

@scopsy scopsy commented Apr 26, 2021

Added support for providing a description text for github deployment.

@scopsy scopsy changed the title Added github deployment description as param feat: Github deployment description support Apr 26, 2021
@nwtgck
Copy link
Copy Markdown
Owner

nwtgck commented Apr 26, 2021

Great! I'll make a small modification.

@nwtgck
Copy link
Copy Markdown
Owner

nwtgck commented Apr 26, 2021

I'm not sure where the description is shown on GitHub UI. But, I'll merge this.

test: #514

@nwtgck nwtgck merged commit e4c631a into nwtgck:develop Apr 26, 2021
Comment thread src/main.ts
? 'pull request'
: 'commit')

const description = inputs.githubDeploymentEnvironment()
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo. This is why I'm noticing the environment in the deployment description. When using this feature, you can query deployments via CLI like so:

curl -H "Accept: application/vnd.github.v3+json" https://api.github.com/repos/nwtgck/actions-netlify/deployments | less

Then look at the JSON data, something like:

    "task": "deploy",
    "original_environment": "pull request",
    "environment": "pull request",
    "description": null,

null would be pull request currently if you enabled the description feature. pull request is the default PR deploy environment if you've not configured a different one.

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.

3 participants