Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Merge requests
  • !12280

Suggest Docker instead of Git BASH in PR template

  • Review changes

  • Download
  • Email patches
  • Plain diff
Open Administrator requested to merge github/fork/LostMekka/bugfix/PR-template-wrong-for-windows-users into master Apr 30, 2022
  • Overview 0
  • Commits 1
  • Pipelines 1
  • Changes 1

Created by: LostMekka

This PR is motivated by this comment.

The PR template mentions that Windows users should use the Git BASH to run the scripts that generate samples and docs. However, when doing this, Windows path separators (backslashes) will creep into almost all of the generated files, which will result in unwanted changes.

This PR changes the PR template to instruct Windows users to run the scripts inside a docker container instead, which will prevent the above issue.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    Commit all changed files. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*. For Windows users, please run the script in Git BASH.
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

(I skipped the build and gen scripts, since there are no changes to the actual project)

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/LostMekka/bugfix/PR-template-wrong-for-windows-users