Skip to content

Open Source required steps #1

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

Merged
merged 12 commits into from
Nov 21, 2022
Merged

Open Source required steps #1

merged 12 commits into from
Nov 21, 2022

Conversation

migue
Copy link
Collaborator

@migue migue commented Nov 17, 2022

This pull request tries to complete all the steps required to release the library as an Open Source project. The different tasks that need to be performed are described in this issue.

Please, not that some of them do not apply to this project, like

Since this is not a production system but a library that will be used by other people to build their final services.

Once this pull request is approved and merged, I will rewrite the history to have a single commit and will Open an issue in github/security-iam in order to make the repository public

@migue migue requested a review from a team as a code owner November 17, 2022 09:17
tgummerer
tgummerer previously approved these changes Nov 21, 2022
Copy link
Contributor

@tgummerer tgummerer left a comment

Choose a reason for hiding this comment

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

One small nit inline that I think is worth fixing. Thanks for preparing this!

@migue
Copy link
Collaborator Author

migue commented Nov 21, 2022

I have pushed a set of changes, so we can run the linter in every pull and locally

The action is complaining:

pipe/pipeline.go:26:5: error-naming: error var FinishEarly should have name of the form ErrFoo (revive)
var FinishEarly = errors.New("finish stage early")

However, this variable annotation seems properly annotated:

// FinishEarly is an error that can be returned by a `Stage` to
// request that the iteration be ended early (possibly without reading
// all of its input). This "error" is considered a successful return,
// and is not reported to the caller.
//
//nolint:errname
var FinishEarly = errors.New("finish stage early")

Will take a look ...

Copy link
Contributor

@tgummerer tgummerer left a comment

Choose a reason for hiding this comment

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

:shipit:

@migue migue merged commit 173aba4 into main Nov 21, 2022
@migue migue deleted the open-source-steps branch November 21, 2022 15:27
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.

2 participants