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

refactor!: rename the source package to scm #536

Merged
merged 8 commits into from
Nov 22, 2021
Merged

refactor!: rename the source package to scm #536

merged 8 commits into from
Nov 22, 2021

Conversation

kneal
Copy link
Contributor

@kneal kneal commented Nov 18, 2021

PR Includes the following changes:

  • Rename the source package to scm
  • Update source to scm messaging

This PR has changes to the environment variables used to configure the server. Its the same spirit as go-vela/community#395 and go-vela/community#394

The goal is to just improve clarity for new users by using a more industry identifiable term.

This is a prelude for me starting: go-vela/community#441

@kneal kneal added the enhancement Indicates an improvement to a feature label Nov 18, 2021
@kneal kneal requested a review from a team as a code owner November 18, 2021 23:03
@kneal kneal self-assigned this Nov 18, 2021
@codecov
Copy link

codecov bot commented Nov 18, 2021

Codecov Report

Merging #536 (b01ce24) into master (d42723a) will not change coverage.
The diff coverage is 63.50%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #536   +/-   ##
=======================================
  Coverage   54.83%   54.83%           
=======================================
  Files         178      178           
  Lines       13498    13498           
=======================================
  Hits         7401     7401           
  Misses       5790     5790           
  Partials      307      307           
Impacted Files Coverage Δ
api/authenticate.go 0.00% <0.00%> (ø)
api/build.go 2.14% <0.00%> (ø)
api/deployment.go 0.00% <0.00%> (ø)
api/pipeline.go 0.00% <0.00%> (ø)
api/repo.go 0.00% <0.00%> (ø)
api/secret.go 0.00% <0.00%> (ø)
api/user.go 0.00% <0.00%> (ø)
api/webhook.go 0.00% <0.00%> (ø)
scm/github/access.go 94.50% <ø> (ø)
scm/github/authentication.go 81.13% <ø> (ø)
... and 12 more

@kneal kneal marked this pull request as draft November 18, 2021 23:14
@JordanSussman
Copy link
Collaborator

This PR has changes to the environment variables used to configure the server. Its the same spirit as go-vela/community#395 and go-vela/community#394

Can the old environment variables be left in the urfave slice to avoid the breaking change?

@kneal
Copy link
Contributor Author

kneal commented Nov 18, 2021

@JordanSussman Yeah, I can add them back with a TODO to remove for a future release

@kneal kneal marked this pull request as ready for review November 18, 2021 23:41
@@ -53,7 +53,7 @@ type client struct {
AuthReq *github.AuthorizationRequest
}

// New returns a Source implementation that integrates with
// New returns a SCM implementation that integrates with
Copy link
Collaborator

Choose a reason for hiding this comment

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

super nitpicky, but this is the first instance i found where "SCM" is actually all caps so it jumped out at me for being inconsistent 🤷🏼‍♂️

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Umm... it should be in all instances S was capitalized for source.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For example here it is in another file:
https://github.com/go-vela/server/pull/536/files#diff-20b08cad4aeb414832e6f834e33e07c46c1be25d5b3fc3d55d602a8fa0d925a5L23

Can definitely modify it so there is no all caps tho, if that is preferred.

Copy link
Collaborator

Choose a reason for hiding this comment

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

like i said, nitpicky.. i approved the PR so do what you will 🤪

Copy link
Member

Choose a reason for hiding this comment

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

Gramatically, I prefer all caps here, but if we're going that far it would be:

Suggested change
// New returns a SCM implementation that integrates with
// New returns an SCM implementation that integrates with

🤪

Copy link
Contributor

Choose a reason for hiding this comment

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

+1 for @cognifloyd

Copy link
Contributor

@jbrockopp jbrockopp left a comment

Choose a reason for hiding this comment

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

LGTM

@kneal kneal merged commit 1bf0240 into master Nov 22, 2021
@kneal kneal deleted the refactor/scm branch November 22, 2021 15:38
@jbrockopp jbrockopp changed the title refactor: rename the source package to scm refactor!: rename the source package to scm Dec 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Indicates an improvement to a feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants