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.

Sign up for GitHub

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

Jump to bottom

Update changelog #53

Merged
merged 4 commits into from
Oct 3, 2019
Merged

Update changelog #53

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c25eb9d
Update changelog and readme
btromanova Oct 3, 2019
f94c6e5
Feedback
btromanova Oct 3, 2019
349c58d
Feedback
btromanova Oct 3, 2019
7be137d
More feedback
btromanova Oct 3, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,36 @@
# astro changelog

## 0.5.0 (UNRELEASED, 2019)
## 0.5.0 (October 3, 2019)
dansimau marked this conversation as resolved.
Show resolved Hide resolved

### Added
* Add ls command to tvm (#37)
* Add `version` command (#12)
* Add binaries via goreleaser (#14)
* Support detach flag with Terraform 0.12 (#45)
* Make plan output work with terraform 0.12 (#41)
dansimau marked this conversation as resolved.
Show resolved Hide resolved
* Add Travis configuration, `make lint` and git precommit hook

### Changed
* Don't pass variables to the modules that don't declare them (#40)
dansimau marked this conversation as resolved.
Show resolved Hide resolved
* Adopt options pattern for `astro.NewProject` constructor (#26)
* Refactor and improve integration tests to invoke them directly using cli
rather than `os.exec` (#26)
* Add Travis configuration, `make lint` and git precommit hook
* Remove godep and move to Go modules (vgo)
* Change configuration syntax for remapping CLI flags to Terraform module
variables

### Security
* Fix zip slip vulnerability (#47)
dansimau marked this conversation as resolved.
Show resolved Hide resolved

### Fixed
* Propagate SIGINT and SIGTERM to terraform (#49)
Copy link
Contributor

Choose a reason for hiding this comment

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

This is more of a code addition/enhancement, I think it should probably go in "Added".

We can also make it say:

* Propagate SIGINT/SIGTERM to Terraform on shut down (avoids stale locks) (#49)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Moved, thanks.

* Fix bug in initialization of allowed values (#43)
* Fix `--help` displaying "pflag: help requested" (#1)
* Fix issue with make not recompiling when source files changed
* Fix issue with `make test` always returning true even when tests fail
* Fix race condition that could cause failures due to astro downloading the
same version of Terraform twice
* Fix module execution errors being printed to the console twice
* Remove godep and move to Go modules (vgo)
* Change configuration syntax for remapping CLI flags to Terraform module
variables

**Breaking changes:**

Expand Down
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,3 +245,12 @@ flags:
```

This will remap the "environment" Terraform variable to `--env` on the astro command line. You can also specify a description that will show up in the `--help` text.

## Contributing to astro
dansimau marked this conversation as resolved.
Show resolved Hide resolved

**Releasing a new version**
Copy link
Contributor

Choose a reason for hiding this comment

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

This reads more easily as a list:

**Releasing a new version**

1. Make sure the CHANGELOG is updated
2. Create and push a new tag named `x.x.x` (following [semver](https://semver.org/))
3. The [release action](https://github.com/uber/astro/actions?workflow=release) will automatically build and upload binaries

Also we can add:

**Making and testing changes to the release process**

1. Make your changes to the [release GitHub action workflow file](https://github.com/uber/astro/actions?workflow=release) and push it to a branch
2. Create a new tag pointing to the tip of the branch (name it: `0.0.0-dev`)
3. Push the tag to trigger the action. The action will use the updated config.
4. Delete the tag after testing (`git tag -d 0.0.0-dev; git push --delete origin 0.0.0-dev`)

Disclaimer: I haven't tested the instructions for "Testing the release process" so we should verify that it works before landing (e.g. that the tag name 0.0.0-dev works).

Copy link
Contributor

Choose a reason for hiding this comment

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

Also I'm starting to think these runbooks should be in the wiki and we should link to there from the README instead of making the README really long.


New version is created by [goreleaser](https://goreleaser.com/) when a new tag is pushed.

To release a new version make sure CHANGELOG is updated, create and push a new tag,
[release github action](https://github.com/uber/astro/actions?workflow=release) will do the rest.