Skip to content

Add a template for release announcements #865

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 1 commit into from
Jul 31, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 19 additions & 0 deletions releases/friends.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
#!/usr/bin/env bash

set -eu
set -o pipefail

cd "$(dirname $0)"

if [[ -z "${1+x}" ]]; then
read -p "List friends since which commit/tag? " since
echo
else
since=$1
fi

git shortlog -s -n "$since.." \
| cut -f 2- \
| sort -u \
| grep -v bors\-servo \
| xargs -I{} echo "- {}"
72 changes: 72 additions & 0 deletions releases/release-announcement-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Announcing `bindgen` $TODO_VERSION

`bindgen` automatically generates Rust FFI bindings to C and C++ libraries.

Upgrade to this release by updating your `Cargo.toml`:

```toml
bindgen = "$TODO_VERSION"
```
Copy link
Member

Choose a reason for hiding this comment

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

I would put this above the links to GH/crates.io since it is probably more useful for many users.


* [GitHub][]
* [crates.io][]
* [Users Guide][guide]
* [API Documentation][docs]

## Changelog

### Added

* TODO (or remove section if none)

### Changed

* TODO (or remove section if none)

### Deprecated

* TODO (or remove section if none)

### Removed

* TODO (or remove section if none)

### Fixed

* TODO (or remove section if none)

### Security

* TODO (or remove section if none)


## Friends

Thanks to everyone who contributed to this release!

<insert the output of friends.sh here>

## Contributing

Want to join us? Check out our [CONTRIBUTING.md][contributing] and take a look
at some of these issues:

* [Issues labeled "easy"][easy]
* [Issues labeled "less easy"][less-easy]
* Still can't find something to work on? [Drop a comment here.][looking]

Want to help improve our documentation?
[Check out the issues labeled "docs".][docs-issues]

Found a bug with `bindgen`? [File an issue here.][file-issue]

[GitHub]: https://github.com/rust-lang-nursery/rust-bindgen
[crates.io]: https://crates.io/crates/bindgen
[guide]: https://rust-lang-nursery.github.io/rust-bindgen
[docs]: https://docs.rs/bindgen
[contributing]: https://github.com/rust-lang-nursery/rust-bindgen/blob/master/CONTRIBUTING.md
[easy]: https://github.com/rust-lang-nursery/rust-bindgen/issues?q=is%3Aopen+is%3Aissue+label%3AE-easy
[less-easy]: https://github.com/rust-lang-nursery/rust-bindgen/issues?q=is%3Aopen+is%3Aissue+label%3AE-less-easy
[looking]: https://github.com/rust-lang-nursery/rust-bindgen/issues/747
[docs-issues]: https://github.com/rust-lang-nursery/rust-bindgen/issues?q=is%3Aopen+is%3Aissue+label%3AI-needs-docs
[file-issue]: https://github.com/rust-lang-nursery/rust-bindgen/issues/new