Skip to content

Commit

Permalink
Rename imports to cnabio
Browse files Browse the repository at this point in the history
Signed-off-by: Jacob LeGrone <[email protected]>
  • Loading branch information
jlegrone committed Dec 6, 2019
1 parent 5bb4d46 commit fc67661
Show file tree
Hide file tree
Showing 46 changed files with 147 additions and 141 deletions.
97 changes: 50 additions & 47 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,26 @@
We have [good first issues][good-first-issue] for new contributors and [help wanted][help-wanted] issues for our other contributors.

* `good first issue` has extra information to help you make your first contribution.
* `help wanted` are issues suitable for someone who isn't a core maintainer.
- `good first issue` has extra information to help you make your first contribution.
- `help wanted` are issues suitable for someone who isn't a core maintainer.

Maintainers will do our best regularly make new issues for you to solve and then help out as you work on them. 💖

# Philosophy

PRs are most welcome!

* If there isn't an issue for your PR, please make an issue first and explain the problem or motivation for
the change you are proposing. When the solution isn't straightforward, for example "Implement missing command X",
then also outline your proposed solution. Your PR will go smoother if the solution is agreed upon before you've
spent a lot of time implementing it.
* It's OK to submit a PR directly for problems such as misspellings or other things where the motivation/problem is
- If there isn't an issue for your PR, please make an issue first and explain the problem or motivation for
the change you are proposing. When the solution isn't straightforward, for example "Implement missing command X",
then also outline your proposed solution. Your PR will go smoother if the solution is agreed upon before you've
spent a lot of time implementing it.
- It's OK to submit a PR directly for problems such as misspellings or other things where the motivation/problem is
unambiguous.
* If you aren't sure about your solution yet, put WIP in the title or open as a draft PR so that people know to be nice and
wait for you to finish before commenting.
* Try to keep your PRs to a single task. Please don't tackle multiple things in a single PR if possible. Otherwise, grouping related changes into commits will help us out a bunch when reviewing!
* We encourage "follow-on PRs". If the core of your changes are good, and it won't hurt to do more of
the changes later, we like to merge early, and keep working on it in another PR so that others can build
on top of your work.
- If you aren't sure about your solution yet, put WIP in the title or open as a draft PR so that people know to be nice and
wait for you to finish before commenting.
- Try to keep your PRs to a single task. Please don't tackle multiple things in a single PR if possible. Otherwise, grouping related changes into commits will help us out a bunch when reviewing!
- We encourage "follow-on PRs". If the core of your changes are good, and it won't hurt to do more of
the changes later, we like to merge early, and keep working on it in another PR so that others can build
on top of your work.

When you're ready to get started, we recommend the following workflow:

Expand All @@ -31,52 +32,54 @@ $ golangci-lint run --config ./golangci.yml

We currently use [dep](https://github.com/golang/dep) for dependency management.

[good-first-issue]: https://github.com/deislabs/cnab-go/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
[help-wanted]: https://github.com/deislabs/cnab-go/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22
[good-first-issue]: https://github.com/cnabio/cnab-go/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
[help-wanted]: https://github.com/cnabio/cnab-go/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22

# Cutting a Release

When you are asked to cut a new release, here is the process:

1. Figure out the correct version number, we follow [semver](semver.org) and
have a funny [release naming scheme][release-name]:
* Bump the major segment if there are any breaking changes.
* Bump the minor segment if there are new features only.
* Bump the patch segment if there are bug fixes only.
* Bump the build segment (version-prerelease.BUILDTAG+releasename) if you only
fixed something in the build, but the final binaries are the same.
have a funny [release naming scheme][release-name]:
- Bump the major segment if there are any breaking changes.
- Bump the minor segment if there are new features only.
- Bump the patch segment if there are bug fixes only.
- Bump the build segment (version-prerelease.BUILDTAG+releasename) if you only
fixed something in the build, but the final binaries are the same.
1. Figure out if the release name (version-prerelease.buildtag+RELEASENAME) should
change.

* Keep the release name the same if it is just a build tag or patch bump.
* It is a new release name for major and minor bumps.

If you need a new release name, it must be conversation with the team.
[Release naming scheme][release-name] explains the meaning behind the
release names.
change.

- Keep the release name the same if it is just a build tag or patch bump.
- It is a new release name for major and minor bumps.

If you need a new release name, it must be conversation with the team.
[Release naming scheme][release-name] explains the meaning behind the
release names.

1. Ensure that the master CI build is passing, then make the tag and push it.

```
git checkout master
git pull
git tag VERSION -a -m ""
git push --tags
```
```
git checkout master
git pull
git tag VERSION -a -m ""
git push --tags
```

1. Generate some release notes and put them into the release on GitHub.
The following command gives you a list of all the merged pull requests:
The following command gives you a list of all the merged pull requests:

```
git log --oneline OLDVERSION..NEWVERSION | grep "#" > gitlog.txt
```
```
git log --oneline OLDVERSION..NEWVERSION | grep "#" > gitlog.txt
```

You need to go through that and make a bulleted list of features
and fixes with the PR titles and links to the PR. If you come up with an
easier way of doing this, please submit a PR to update these instructions. 😅
You need to go through that and make a bulleted list of features
and fixes with the PR titles and links to the PR. If you come up with an
easier way of doing this, please submit a PR to update these instructions. 😅

```
# Features
* PR TITLE (#PR NUMBER)
```
# Features
* PR TITLE (#PR NUMBER)
# Fixes
* PR TITLE (#PR NUMBER)
# Fixes
* PR TITLE (#PR NUMBER)
```
6 changes: 4 additions & 2 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# Governance

## Project Maintainers

[Project maintainers](CODEOWNERS) are responsible for activities around maintaining and updating CNAB-go, a library for the [CNAB spec](https://github.com/deislabs/cnab-spec). Final decisions on the project reside with the project maintainers.

Maintainers MUST remain active. If they are unresponsive for >3 months, they will be automatically removed unless a [super-majority](https://en.wikipedia.org/wiki/Supermajority#Two-thirds_vote) of the other project maintainers agrees to extend the period to be greater than 3 months.

New maintainers can be added to the project by a [super-majority](https://en.wikipedia.org/wiki/Supermajority#Two-thirds_vote) vote of the existing maintainers.

A maintainer may step down by submitting an [issue](https://github.com/deislabs/cnab-go/issues/new) stating their intent.
A maintainer may step down by submitting an [issue](https://github.com/cnabio/cnab-go/issues/new) stating their intent.

## Code of Conduct

This project has adopted the [Microsoft Open Source Code of conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,25 @@ cnab-go is currently being used by [Docker App](https://github.com/docker/app),

### Community

cnab-go is [maintained](GOVERNANCE.md) by the CNAB community. We sometimes discuss cnab-go issues during the [bi-weekly CNAB community meeting](https://hackmd.io/s/SyGcBcwQ4), but we encourage open communication via our [issue](https://github.com/deislabs/cnab-go/issues) queue and via [PRs](https://github.com/deislabs/cnab-go/pulls). If you are interested in contributing to cnab-go, please refer to our [contributing](CONTRIBUTING.md) guidelines.
cnab-go is [maintained](GOVERNANCE.md) by the CNAB community. We sometimes discuss cnab-go issues during the [bi-weekly CNAB community meeting](https://hackmd.io/s/SyGcBcwQ4), but we encourage open communication via our [issue](https://github.com/cnabio/cnab-go/issues) queue and via [PRs](https://github.com/cnabio/cnab-go/pulls). If you are interested in contributing to cnab-go, please refer to our [contributing](CONTRIBUTING.md) guidelines.

### Development

#### Getting the code

Cloning this repository and change directory to it:

```bash
$ go get -d github.com/deislabs/cnab-go/...
$ cd $(go env GOPATH)/src/github.com/deislabs/cnab-go
$ go get -d github.com/cnabio/cnab-go/...
$ cd $(go env GOPATH)/src/github.com/cnabio/cnab-go
```

#### Prerequisites

You need:

* make
* Go
- make
- Go

#### Get dependencies

Expand Down Expand Up @@ -60,7 +61,7 @@ $ make integration-test
```

This will only run the linter to ensure the code meet the standard.
*It does not format the code*
_It does not format the code_

```bash
$ make lint
Expand Down
10 changes: 5 additions & 5 deletions action/action.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ import (
"math"
"strings"

"github.com/deislabs/cnab-go/bundle"
"github.com/deislabs/cnab-go/bundle/definition"
"github.com/deislabs/cnab-go/claim"
"github.com/deislabs/cnab-go/credentials"
"github.com/deislabs/cnab-go/driver"
"github.com/cnabio/cnab-go/bundle"
"github.com/cnabio/cnab-go/bundle/definition"
"github.com/cnabio/cnab-go/claim"
"github.com/cnabio/cnab-go/credentials"
"github.com/cnabio/cnab-go/driver"
)

// stateful is there just to make callers of opFromClaims more readable
Expand Down
10 changes: 5 additions & 5 deletions action/action_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ import (
"testing"
"time"

"github.com/deislabs/cnab-go/claim"
"github.com/deislabs/cnab-go/credentials"
"github.com/deislabs/cnab-go/driver"
"github.com/cnabio/cnab-go/claim"
"github.com/cnabio/cnab-go/credentials"
"github.com/cnabio/cnab-go/driver"

"github.com/deislabs/cnab-go/bundle"
"github.com/deislabs/cnab-go/bundle/definition"
"github.com/cnabio/cnab-go/bundle"
"github.com/cnabio/cnab-go/bundle/definition"

"github.com/stretchr/testify/assert"
)
Expand Down
6 changes: 3 additions & 3 deletions action/install.go
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
package action

import (
"github.com/deislabs/cnab-go/claim"
"github.com/deislabs/cnab-go/credentials"
"github.com/deislabs/cnab-go/driver"
"github.com/cnabio/cnab-go/claim"
"github.com/cnabio/cnab-go/credentials"
"github.com/cnabio/cnab-go/driver"
)

// Install describes an installation action
Expand Down
4 changes: 2 additions & 2 deletions action/install_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ import (
"io/ioutil"
"testing"

"github.com/deislabs/cnab-go/claim"
"github.com/deislabs/cnab-go/driver"
"github.com/cnabio/cnab-go/claim"
"github.com/cnabio/cnab-go/driver"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
Expand Down
2 changes: 1 addition & 1 deletion action/operation_configs.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package action

import (
"github.com/deislabs/cnab-go/driver"
"github.com/cnabio/cnab-go/driver"
)

// OperationConfigFunc is a configuration function that can be applied to an
Expand Down
2 changes: 1 addition & 1 deletion action/operation_configs_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"os"
"testing"

"github.com/deislabs/cnab-go/driver"
"github.com/cnabio/cnab-go/driver"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
Expand Down
6 changes: 3 additions & 3 deletions action/run_custom.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ package action
import (
"errors"

"github.com/deislabs/cnab-go/claim"
"github.com/deislabs/cnab-go/credentials"
"github.com/deislabs/cnab-go/driver"
"github.com/cnabio/cnab-go/claim"
"github.com/cnabio/cnab-go/credentials"
"github.com/cnabio/cnab-go/driver"
)

var (
Expand Down
6 changes: 3 additions & 3 deletions action/run_custom_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ import (
"io/ioutil"
"testing"

"github.com/deislabs/cnab-go/bundle"
"github.com/deislabs/cnab-go/claim"
"github.com/deislabs/cnab-go/driver"
"github.com/cnabio/cnab-go/bundle"
"github.com/cnabio/cnab-go/claim"
"github.com/cnabio/cnab-go/driver"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
Expand Down
6 changes: 3 additions & 3 deletions action/status.go
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
package action

import (
"github.com/deislabs/cnab-go/claim"
"github.com/deislabs/cnab-go/credentials"
"github.com/deislabs/cnab-go/driver"
"github.com/cnabio/cnab-go/claim"
"github.com/cnabio/cnab-go/credentials"
"github.com/cnabio/cnab-go/driver"
)

// Status runs a status action on a CNAB bundle.
Expand Down
2 changes: 1 addition & 1 deletion action/status_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"io/ioutil"
"testing"

"github.com/deislabs/cnab-go/driver"
"github.com/cnabio/cnab-go/driver"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
Expand Down
6 changes: 3 additions & 3 deletions action/uninstall.go
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
package action

import (
"github.com/deislabs/cnab-go/claim"
"github.com/deislabs/cnab-go/credentials"
"github.com/deislabs/cnab-go/driver"
"github.com/cnabio/cnab-go/claim"
"github.com/cnabio/cnab-go/credentials"
"github.com/cnabio/cnab-go/driver"
)

// Uninstall runs an uninstall action
Expand Down
4 changes: 2 additions & 2 deletions action/uninstall_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ import (
"io/ioutil"
"testing"

"github.com/deislabs/cnab-go/claim"
"github.com/deislabs/cnab-go/driver"
"github.com/cnabio/cnab-go/claim"
"github.com/cnabio/cnab-go/driver"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
Expand Down
6 changes: 3 additions & 3 deletions action/upgrade.go
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
package action

import (
"github.com/deislabs/cnab-go/claim"
"github.com/deislabs/cnab-go/credentials"
"github.com/deislabs/cnab-go/driver"
"github.com/cnabio/cnab-go/claim"
"github.com/cnabio/cnab-go/credentials"
"github.com/cnabio/cnab-go/driver"
)

// Upgrade runs an upgrade action
Expand Down
4 changes: 2 additions & 2 deletions action/upgrade_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ import (
"io/ioutil"
"testing"

"github.com/deislabs/cnab-go/claim"
"github.com/deislabs/cnab-go/driver"
"github.com/cnabio/cnab-go/claim"
"github.com/cnabio/cnab-go/driver"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
Expand Down
2 changes: 1 addition & 1 deletion bundle/bundle.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
"strings"

"github.com/Masterminds/semver"
"github.com/deislabs/cnab-go/bundle/definition"
"github.com/cnabio/cnab-go/bundle/definition"
"github.com/docker/go/canonical/json"
pkgErrors "github.com/pkg/errors"
)
Expand Down
2 changes: 1 addition & 1 deletion bundle/bundle_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"io/ioutil"
"testing"

"github.com/deislabs/cnab-go/bundle/definition"
"github.com/cnabio/cnab-go/bundle/definition"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

Expand Down
2 changes: 1 addition & 1 deletion bundle/loader/loader.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import (
"net/url"
"os"

"github.com/deislabs/cnab-go/bundle"
"github.com/cnabio/cnab-go/bundle"
)

// BundleLoader provides an interface for loading a bundle
Expand Down
2 changes: 1 addition & 1 deletion claim/claim.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (

"github.com/oklog/ulid"

"github.com/deislabs/cnab-go/bundle"
"github.com/cnabio/cnab-go/bundle"
)

// Status constants define the CNAB status fields on a Result.
Expand Down
Loading

0 comments on commit fc67661

Please sign in to comment.