Skip to content

Add workflow_dispatch to generate-query-help-docs.yml#4808

Merged
jf205 merged 4 commits intomainfrom
jf205-patch-2
Dec 12, 2020
Merged

Add workflow_dispatch to generate-query-help-docs.yml#4808
jf205 merged 4 commits intomainfrom
jf205-patch-2

Conversation

@jf205
Copy link
Contributor

@jf205 jf205 commented Dec 10, 2020

This PR adds a workflow_dispatch event to the workflow for generating the query help documentation, so that we can trigger query help generation manually. I've also removed main and rc/** from the push events because we only really want to run this workflow when upgrading the distribution on lgtm.com.

@jf205 jf205 requested a review from adityasharad December 11, 2020 09:07
Copy link
Collaborator

@adityasharad adityasharad left a comment

Choose a reason for hiding this comment

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

Sounds sensible, some simplification possible in the code.

Comment on lines 9 to 12
Copy link
Collaborator

Choose a reason for hiding this comment

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

You don't need this: ref is already a part of the workflow_dispatch event. To run against the lgtm.com branch, just choose that branch in the dispatch UI.

Suggested change
ref:
description: The branch in github/codeql to checkout when generating query help.
required: false
default: 'lgtm.com'

Comment on lines 29 to 35
Copy link
Collaborator

Choose a reason for hiding this comment

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

Also not needed: if no ref is supplied to actions/checkout, it defaults to github.ref which will come from the dispatch event. The existing code is fine.

Suggested change
path: codeql
ref: ${{ github.event.inputs.ref }}
- if: github.event.inputs.ref == ''
name: Clone github/codeql (default ref)
uses: actions/checkout@v2
with:
path: codeql
path: codeql

@jf205 jf205 merged commit ca80f04 into main Dec 12, 2020
@jf205 jf205 deleted the jf205-patch-2 branch December 12, 2020 13:46
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.

2 participants

Comments