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

docs(readme): fix container image build cmds: drop / from branch names #3655

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

petermetz
Copy link
Contributor

Previously if you executed the image build commands that use the branch name
to produce container image tag names then you received an error if your branch
name contained a forward slash (/) which is common for people who use VSCode
extensions for managing branches related to pull requests.

The new commands are using sed to remove the forward slashes from the branch names
and replace them with underscores (_) so that the container image tags are
valid.

Signed-off-by: Peter Somogyvari [email protected]

Pull Request Requirements

  • Rebased onto upstream/main branch and squashed into single commit to help maintainers review it more efficient and to avoid spaghetti git commit graphs that obfuscate which commit did exactly what change, when and, why.
  • Have git sign off at the end of commit message to avoid being marked red. You can add -s flag when using git commit command. You may refer to this link for more information.
  • Follow the Commit Linting specification. You may refer to this link for more information.

Character Limit

  • Pull Request Title and Commit Subject must not exceed 72 characters (including spaces and special characters).
  • Commit Message per line must not exceed 80 characters (including spaces and special characters).

A Must Read for Beginners
For rebasing and squashing, here's a must read guide for beginners.

Previously if you executed the image build commands that use the branch name
to produce container image tag names then you received an error if your branch
name contained a forward slash (/) which is common for people who use VSCode
extensions for managing branches related to pull requests.

The new commands are using `sed` to remove the forward slashes from the branch names
and replace them with underscores (_) so that the container image tags are
valid.

Signed-off-by: Peter Somogyvari <[email protected]>
Copy link
Contributor

@jagpreetsinghsasan jagpreetsinghsasan left a comment

Choose a reason for hiding this comment

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

LGTM

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.

3 participants