Merge pull request #31 from ably/document-release-process

Document the release process

CHANGELOG.md

@@ -0,0 +1,50 @@
+# Changelog
+
+## [v1.0.1](https://github.com/ably/kafka-connect-ably/tree/v1.0.1) (2021-08-25)
+
+[Full Changelog](https://github.com/ably/kafka-connect-ably/compare/v1.0.0...v1.0.1)
+
+**Closed issues:**
+
+- Issue when installing the connector [\#18](https://github.com/ably/kafka-connect-ably/issues/18)
+- Issue when installing the connector [\#17](https://github.com/ably/kafka-connect-ably/issues/17)
+- Review Kafka code for Tech Preview [\#16](https://github.com/ably/kafka-connect-ably/issues/16)
+- test [\#15](https://github.com/ably/kafka-connect-ably/issues/15)
+- Publish to Confluent Hub [\#13](https://github.com/ably/kafka-connect-ably/issues/13)
+- Review Kafka code for Tech Preview [\#12](https://github.com/ably/kafka-connect-ably/issues/12)
+- Review Kafka code for Tech Preview [\#11](https://github.com/ably/kafka-connect-ably/issues/11)
+
+**Merged pull requests:**
+
+- Add ownerLogo [\#24](https://github.com/ably/kafka-connect-ably/pull/24) ([lmars](https://github.com/lmars))
+- Add logo [\#23](https://github.com/ably/kafka-connect-ably/pull/23) ([lmars](https://github.com/lmars))
+- Refactor project code [\#22](https://github.com/ably/kafka-connect-ably/pull/22) ([KacperKluka](https://github.com/KacperKluka))
+- Use consistent naming: 'Ably Kafka Connector' [\#20](https://github.com/ably/kafka-connect-ably/pull/20) ([lmars](https://github.com/lmars))
+- Fix build failure relating to Kafka Connect parent POM [\#19](https://github.com/ably/kafka-connect-ably/pull/19) ([QuintinWillison](https://github.com/QuintinWillison))
+
+## [v1.0.0](https://github.com/ably/kafka-connect-ably/tree/v1.0.0) (2021-06-24)
+
+[Full Changelog](https://github.com/ably/kafka-connect-ably/compare/238dc7d401067a37b7950bce5d29a9a270a9faaa...v1.0.0)
+
+**Implemented enhancements:**
+
+- Test issue [\#2](https://github.com/ably/kafka-connect-ably/issues/2)
+
+**Closed issues:**
+
+- Update configuration and running locally docs [\#8](https://github.com/ably/kafka-connect-ably/issues/8)
+- Migrate kafka-connect-ably Java packages from io.ably to com.ably [\#7](https://github.com/ably/kafka-connect-ably/issues/7)
+- Write tests for Kafka Connect Library [\#4](https://github.com/ably/kafka-connect-ably/issues/4)
+- Sync test 2 [\#3](https://github.com/ably/kafka-connect-ably/issues/3)
+
+**Merged pull requests:**
+
+- DOC-303: Update README with configuration properties and installation instructions [\#14](https://github.com/ably/kafka-connect-ably/pull/14) ([m-hulbert](https://github.com/m-hulbert))
+- Rename package from io.ably.kakfa.\* to com.ably.kafka.\* [\#10](https://github.com/ably/kafka-connect-ably/pull/10) ([lmars](https://github.com/lmars))
+- Update configuration and running locally docs [\#6](https://github.com/ably/kafka-connect-ably/pull/6) ([lmars](https://github.com/lmars))
+- Add integration test [\#5](https://github.com/ably/kafka-connect-ably/pull/5) ([lmars](https://github.com/lmars))
+- Put Kafka key and headers in Ably message extras [\#1](https://github.com/ably/kafka-connect-ably/pull/1) ([lmars](https://github.com/lmars))
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

CONTRIBUTING.md

@@ -0,0 +1,46 @@
+# Contributing
+
+## Development Flow
+
+1. Fork the GitHub repository and clone it to your local machine
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Ensure you have added suitable tests and the test suite is passing (see [Running Tests](#running-tests) below)
+5. Push the feature branch to GitHub (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+### Building
+
+Build the connector using [Maven](https://maven.apache.org/):
+
+    mvn clean package
+
+## Running Tests
+
+There are both unit tests and integration tests that can be run using [Maven](https://maven.apache.org/).
+
+Run the unit tests:
+
+    mvn test
+
+Run the integration tests:
+
+    mvn verify
+
+## Release Process
+
+This library uses [semantic versioning](http://semver.org/). For each release, the following needs to be done:
+
+1. Create a branch for the release, named like `release/1.0.2` (where `1.0.2` is the new version you want to release)
+2. Update the version number in the `product.version` element of [`pom.xml`](./pom.xml)
+3. Run [`github_changelog_generator`](https://github.com/github-changelog-generator/github-changelog-generator) to automate the update of the [CHANGELOG](./CHANGELOG.md). This may require some manual intervention, both in terms of how the command is run and how the change log file is modified. Your mileage may vary:
+  * The command you will need to run will look something like this: `github_changelog_generator -u ably -p kafka-connect-ably --since-tag v1.0.1 --output delta.md`
+  * Using the command above, `--output delta.md` writes changes made after `--since-tag` to a new file
+  * The contents of that new file (`delta.md`) then need to be manually inserted at the top of the `CHANGELOG.md`, changing the "Unreleased" heading and linking with the current version numbers
+  * Also ensure that the "Full Changelog" link points to the new version tag instead of the `HEAD`
+  * Commit this change: `git add CHANGELOG.md && git commit -m "Update change log."`
+4. Make a PR against `main`
+5. Once the PR is approved, merge it into `main`
+6. Add a tag and push to origin - e.g.: `git tag v1.0.2 && git push origin v1.0.2`
+7. Create the release on Github including populating the release notes
+8. Notify the product team that a new ZIP file needs to be sent to Confluent Hub, which can be downloaded at the following URL: https://sdk.ably.com/builds/ably/kafka-connect-ably/main/kafka-connect-ably/ably-kafka-connect-ably-1.0.2.zip

README.md

@@ -134,3 +134,7 @@ The advanced properties that can be configured for the connector are:
 | client.transport.params | Any additional parameters to be sent in the query string when initiating a realtime connection in the format `key1=value1,key2=value` without URL encoding. | *List* ||
 | client.use.binary.protocol | Set to `false` to force the library to use JSON encoding for REST and realtime operations, instead of msgpack encoding. | *Boolean* | True |
 | client.loglevel | Sets the verbosity of logging. | *Integer* | 0 |
+
+## Contributing
+
+For guidance on how to contribute to this project, see [CONTRIBUTING.md](CONTRIBUTING.md).