Skip to content

[BUG] - OneFlow scripts don't verify git remotes #93

@smaillet

Description

@smaillet

Please provide the following information when submitting an issue.

I have already...

  • Reproduced the problem using the latest stable release.
  • Reviewed the documentation.
  • Reviewed the current issues to check that the issue isn't already known.

Description:
The OneFlow scripts blindly assume git remotes are configured and will partially succeed before failing if the remotes are not configured for GitHub. The normal use is:

Name Description
origin Refers to the fork on GitHub where changes are pushed before a PR is made
official Refers to the official repo on GitHub where PR are submitted
The origin is normally set up when cloning the repo, though it may be for the official if that is used for the clone instead of a fork. Either way the second repository is required. While the names don't matter, at least ONE of the remotes MUST refer to the official URL. Whatever name is used for that one is what is the official`` branch (For simplicity and clarity it usually is official`.

The problem is that the OneFlow scripts all assume this and don't VERIFY any of it. This causes them to partially succeed and fail on some commands. This requires manually unwinding the partial success and discovering the problem. It would be better if they detected and reported the specific problems.

Steps to reproduce the problem:

  • Reviewed the documentation.
  • Included Sample code or link to repository/gist to reproduce the bug (This is the fastest way to a resolution as it reduces the time to reproduce the problem. The smaller the sample is the better.)

Expected Behavior

OneFlow scripts report informative messages about assumptions that aren't true.

Actual Behavior
Throws an exception that doesn't make much sense and doesn't help with understanding the root problem.

Additional context
Usually this is a one time problem when setting up a new machine, but it is a major PITA to encounter when the pressure is on to fix a simple dependent vulnerability.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugReported as a bug

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions