This is an automated email from the ASF dual-hosted git repository.
altay pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/beam.git
The following commit(s) were added to refs/heads/master by this push:
new 498218e Add CHANGES.md file
new 8f177b5 Merge pull request #10743 from aaltay/changes
498218e is described below
commit 498218e48c9233dad98280c3d3212621a3720146
Author: Ahmet Altay <[email protected]>
AuthorDate: Fri Jan 31 17:05:37 2020 -0800
Add CHANGES.md file
---
.github/PULL_REQUEST_TEMPLATE.md | 1 +
CHANGES.md | 52 +++++++++++++++++++++++++++++++
website/src/contribute/committer-guide.md | 2 ++
website/src/contribute/release-guide.md | 5 ++-
4 files changed, 59 insertions(+), 1 deletion(-)
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 5471f12..8f78c4e 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -6,6 +6,7 @@ Thank you for your contribution! Follow this checklist to help
us incorporate yo
- [ ] [**Choose
reviewer(s)**](https://beam.apache.org/contribute/#make-your-change) and
mention them in a comment (`R: @username`).
- [ ] Format the pull request title like `[BEAM-XXX] Fixes bug in
ApproximateQuantiles`, where you replace `BEAM-XXX` with the appropriate JIRA
issue, if applicable. This will automatically link the pull request to the
issue.
+ - [ ] Update `CHANGES.md` with noteworthy changes.
- [ ] If this contribution is large, please file an Apache [Individual
Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
See the [Contributor Guide](https://beam.apache.org/contribute) for more tips
on [how to make review process
smoother](https://beam.apache.org/contribute/#make-reviewers-job-easier).
diff --git a/CHANGES.md b/CHANGES.md
new file mode 100644
index 0000000..d207e99
--- /dev/null
+++ b/CHANGES.md
@@ -0,0 +1,52 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# Current version (not yet released; still in development)
+
+## Highlights
+
+ * New highly anticipated feature X added to Python SDK
([BEAM-X](https://issues.apache.org/jira/browse/BEAM-X)).
+ * New highly anticipated feature Y added to JavaSDK
([BEAM-Y](https://issues.apache.org/jira/browse/BEAM-Y)).
+
+### I/Os
+* Support for X source added (Java/Python)
([BEAM-X](https://issues.apache.org/jira/browse/BEAM-X)).
+
+### New Features / Improvements
+
+* X feature added (Java/Python)
([BEAM-X](https://issues.apache.org/jira/browse/BEAM-X)).
+
+### Breaking Changes
+
+* X behavior was changed
([BEAM-X](https://issues.apache.org/jira/browse/BEAM-X)).
+
+### Deprecations
+
+* X behavior is deprecated and will be removed in X versions
([BEAM-X](https://issues.apache.org/jira/browse/BEAM-X)).
+
+### Bugfixes
+
+* Fixed X (Java/Python)
([BEAM-X](https://issues.apache.org/jira/browse/BEAM-X)).
+
+### Known Issues
+
+* ([BEAM-X](https://issues.apache.org/jira/browse/BEAM-X)).
+
+# [2.19.0] - 2020-01-31
+
+- For versions 2.19.0 and older release notes are available on [Apache Beam
Blog](https://beam.apache.org/blog/).
\ No newline at end of file
diff --git a/website/src/contribute/committer-guide.md
b/website/src/contribute/committer-guide.md
index 4a79432..0a3dc2b 100644
--- a/website/src/contribute/committer-guide.md
+++ b/website/src/contribute/committer-guide.md
@@ -106,6 +106,8 @@ rollback; it is easy to roll back many commits, or a whole
pull request, but
harder to roll back part of a commit.
* Commit messages should tag JIRAs and be otherwise descriptive.
It should later not be necessary to find a merge or first PR commit to find
out what caused a change.
+* `CHANGES.md` file should be updated with noteworthy changes (e.g. new
features, backward
+incompatible changes, dependency changes, etc.).
* Squash the "Fixup!", "Address comments" type of commits that resulted from
review iterations.
## Merging it!
diff --git a/website/src/contribute/release-guide.md
b/website/src/contribute/release-guide.md
index b34956c..137e691 100644
--- a/website/src/contribute/release-guide.md
+++ b/website/src/contribute/release-guide.md
@@ -825,6 +825,9 @@ This pull request is against the `apache/beam` repo, on the
`master` branch.
Write a blog post similar to
https://beam.apache.org/blog/2019/08/22/beam-2.15.0.html
+- Update `CHANGES.md` by adding a new section for the next release.
+- Copy the changes for the current release from `CHANGES.md` to the blog post
and edit as necessary.
+
__Tip__: Use git log to find contributors to the releases. (e.g: `git log
--pretty='%aN' ^v2.10.0 v2.11.0 | sort | uniq`).
Make sure to clean it up, as there may be duplicate or incorrect user names.
@@ -857,7 +860,7 @@ Template:
### Breaking Changes
* X behavior was changed
([BEAM-X](https://issues.apache.org/jira/browse/BEAM-X)).
- * Y behavior was changed
([BEAM-Y](https://issues.apache.org/jira/browse/BEAM-X)).
+ * Y behavior was changed
([BEAM-Y](https://issues.apache.org/jira/browse/BEAM-Y)).
### Deprecations
