Skip to content

Commit

Permalink
Prepare v1.0.0 (#588)
Browse files Browse the repository at this point in the history
  • Loading branch information
Grayson Koonce committed Jul 31, 2017
1 parent 7a8127a commit 3cdc81a
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 18 deletions.
16 changes: 9 additions & 7 deletions CHANGELOG.md
@@ -1,13 +1,15 @@
# Changelog

## v1.0.0-rc3 (unreleased)
## v1.0.0 (2017-07-31)

First stable release: no breaking changes will be made in the 1.x series.

- **[Breaking]** Rename `fx.Inject` to `fx.Extract`.
- **[Breaking]** Rename `fxtest.Must*` to `fxtest.Require*`.
- **[Breaking]** Remove `fx.Timeout` and `fx.DefaultTimeout`.
- `fx.Extract` now supports `fx.In` tags on target structs.

## v1.0.0-rc2 (21 Jul 2017)
## v1.0.0-rc2 (2017-07-21)

- **[Breaking]** Lifecycle hooks now take a context.
- Add `fx.In` and `fx.Out` which exposes optional and named types.
Expand All @@ -22,15 +24,15 @@
- Add `fxtest.App`, which redirects log output to the user's `testing.TB` and
provides some lifecycle helpers.

## v1.0.0-rc1 (20 Jun 2017)
## v1.0.0-rc1 (2017-06-20)

- **[Breaking]** Providing types into `fx.App` and invoking functions are now
options passed during application construction. This makes users'
interactions with modules and collections of modules identical.
- **[Breaking]** `TestLifecycle` is now in a separate `fxtest` subpackage.
- Add `fx.Inject()` to pull values from the container into a struct.

## v1.0.0-beta4 (12 Jun 2017)
## v1.0.0-beta4 (2017-06-12)

- **[Breaking]** Monolithic framework, as released in initial betas, has been
broken into smaller pieces as a result of recent advances in `dig` library.
Expand All @@ -47,7 +49,7 @@
(configuration, metrics, tracing) has been deprecated in favor of
`fx.App`.

## v1.0.0-beta3 (28 Mar 2017)
## v1.0.0-beta3 (2017-03-28)

- **[Breaking]** Environment config provider was removed. If you were using
environment variables to override YAML values, see
Expand All @@ -72,7 +74,7 @@
- **[Breaking]** Pass a tracer the `uhttp/uhttpclient` constructor explicitly, instead
of using a global tracer. This will allow to use http client in parallel tests.

## v1.0.0-beta2 (09 Mar 2017)
## v1.0.0-beta2 (2017-03-09)

- **[Breaking]** Remove `ulog.Logger` interface and expose `*zap.Logger` directly.
- **[Breaking]** Rename config and module from `modules.rpc` to `modules.yarpc`
Expand All @@ -97,7 +99,7 @@
- DIG constructors now support returning a tuple with the second argument being
an error.

## v1.0.0-beta1 (20 Feb 2017)
## v1.0.0-beta1 (2017-02-20)

This is the first beta release of the framework, where we invite users to start
building services on it and provide us feedback. **Warning** we are not
Expand Down
14 changes: 9 additions & 5 deletions README.md
Expand Up @@ -5,16 +5,20 @@ An application framework for Go that:
* Makes dependency injection easy.
* Eliminates the need for global state and `func init()`.

## Status
## Installation

Almost stable: `v1.0.0-rc2`. Some breaking changes might occur before `v1.0.0`. See [CHANGELOG.md](CHANGELOG.md) for more info.

## Install
We recommend locking to [SemVer](http://semver.org/) range `^1` using [Glide](https://github.com/Masterminds/glide):

```
go get -u go.uber.org/fx
glide get 'go.uber.org/fx#^1'
```

## Stability

This library is `v1` and follows [SemVer](http://semver.org/) strictly.

No breaking changes will be made to exported APIs before `v2.0.0`.

[doc]: https://godoc.org/go.uber.org/fx
[doc-img]: https://godoc.org/go.uber.org/fx?status.svg
[cov]: https://codecov.io/gh/uber-go/fx/branch/dev
Expand Down
8 changes: 4 additions & 4 deletions glide.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion glide.yaml
Expand Up @@ -3,7 +3,7 @@ import:
- package: go.uber.org/multierr
version: ^1
- package: go.uber.org/dig
version: master #TODO(glib): pin to RC3/^1 when dig is ready
version: ^1
testImport:
- package: github.com/stretchr/testify
version: ~1.1.4
Expand Down
2 changes: 1 addition & 1 deletion version.go
Expand Up @@ -21,4 +21,4 @@
package fx

// Version is exported for runtime compatibility checks.
const Version = "1.0.0-rc3"
const Version = "1.0.0"

0 comments on commit 3cdc81a

Please sign in to comment.