OpenAPITools / OpenAPITools/openapi-generator

[BUG] Update PR template file to contain all scripts to run

Open
#14,502 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist

This is a workflow template issue, not an openapi generators problem. This should help reduce the amount of failing PR github actions.

Description

The current list of items to be run in the PR template is incomplete. Looking at the Docs up-to-date workflow, an additional bin script is run which was making the PR fail in my case. I added it to the template.

openapi-generator version

Not applicable

OpenAPI declaration file content or url

Not applicable

Generation Details

Not applicable

Steps to reproduce

Create a PR with a new generator. The docs/generators.md will be changed when running bin/utils/export_generators_readme.sh, but it is not indicated to run it to complete the PR. It will lead the PR to fail.

Running the script and pushing the updated file fixes the issue.

Related issues/PRs
Suggest a fix

Fixed in https://github.com/OpenAPITools/openapi-generator/pull/14501

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the repository's PR template and compare its listed commands with bin/utils/export_generators_readme.sh and the Docs up-to-date workflow linked in the issue. Done means the template identifies every required script for a new generator PR, but pull request #14501 already claims to fix this issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, shell
Domain
ci-cd
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.