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

remove md from register buildpack issue body #743

Merged
merged 1 commit into from
Jul 16, 2020

Conversation

elbandito
Copy link
Member

Summary

This PR removes unnecessary md formatting for something that is intended to be machine parse-able. The only requirement is that it's TOML. Also added a small clean-up.

Output

id = "projectriff/java-function"
version = "0.4.2"
addr = "gcr.io/projectriff/java-function@sha256:aeab8d5b5cfa4d06fa0a099a1ebf26ad953c146d79a845f9283dac3986e8cf1e"

Before

Data

id = "projectriff/node-function"
version = "0.6.2"
addr = "gcr.io/projectriff/node-function@sha256:9d88250dfd77dbf5a535f1358c6a05dc2c0d3a22defbdcd72bb8f5e24b84e21d"

After

id = "projectriff/java-function"
version = "0.4.2"
addr = "gcr.io/projectriff/java-function@sha256:aeab8d5b5cfa4d06fa0a099a1ebf26ad953c146d79a845f9283dac3986e8cf1e"

Documentation

  • Should this change be documented?
    • Yes, see #___
    • No

Related

Resolves #___

@codecov
Copy link

codecov bot commented Jul 14, 2020

Codecov Report

Merging #743 into main will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #743   +/-   ##
=======================================
  Coverage   73.52%   73.52%           
=======================================
  Files          75       75           
  Lines        5135     5135           
=======================================
  Hits         3775     3775           
  Misses       1043     1043           
  Partials      317      317           
Flag Coverage Δ
#os_linux 76.02% <100.00%> (ø)
#os_macos 71.91% <100.00%> (ø)
#os_windows 71.83% <100.00%> (ø)
#unit 73.52% <100.00%> (ø)

Signed-off-by: Travis <longoria.public@gmail.com>
@elbandito elbandito marked this pull request as ready for review July 14, 2020 17:13
@elbandito elbandito requested a review from a team as a code owner July 14, 2020 17:13
Copy link
Member

@dfreilich dfreilich left a comment

Choose a reason for hiding this comment

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

LGTM!

What sparked this? Did the md cause an issue?

@@ -17,7 +17,7 @@ type Buildpack struct {
}

// Validate that a buildpack reference contains required information
func (b *Buildpack) Validate() error {
func Validate(b Buildpack) error {
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
func Validate(b Buildpack) error {
func Validate (b Buildpack) error {

@elbandito
Copy link
Member Author

LGTM!

What sparked this? Did the md cause an issue?

I'm working on the corresponding Github Action effort to consume/process these issues - I don't want to have to deal with parsing multiple format types, especially if not necessary.

@dfreilich
Copy link
Member

UA: Made gh issue

$  out/pack register-buildpack cnbs/sample-package:hello-universe
Successfully registered cnbs/sample-package:hello-universe

with config

experimental = true
default-registry="official"

[[registries]]
name="official"
type="github"
url="https://github.com/elbandito/buildpack-registry/"

which looks like:
image

@elbandito elbandito merged commit 804184e into main Jul 16, 2020
@elbandito elbandito deleted the remove_md_regbp_template branch July 16, 2020 23:31
@jromero jromero added the type/enhancement Issue that requests a new feature or improvement. label Jul 27, 2020
@jromero jromero added this to the 0.13.0 milestone Jul 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/enhancement Issue that requests a new feature or improvement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants