Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the additional arguments needed in the workflow file #1546

Open
motatoes opened this issue Jun 3, 2024 · 0 comments
Open

Document the additional arguments needed in the workflow file #1546

motatoes opened this issue Jun 3, 2024 · 0 comments

Comments

@motatoes
Copy link
Contributor

motatoes commented Jun 3, 2024

In #1543 we have supported dynamic names for workflows. This is a breaking change since anyone who upgrades will need to also update their workflow files to include the additional inputs run_name:

name: Digger Workflow

on:
  workflow_dispatch:
    inputs:
      id:
        description: 'run identifier'
        required: false
      job:
        required: true
      run_name:
        description: 'the run name'
        required: false

furthermore, they will also need to include a run-name argument in their workflow to benifit from this change:

run-name: '${{inputs.run_name}}'

We need to make sure that all the documentation is updated to reflect this and also add a troubleshooting guide for when errors such as this do exist for the unaware:

422 unexpected input of type "project_name"
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

No branches or pull requests

1 participant