From e4f3da961356a8363a7cdf721fbadd1aa14aa3e6 Mon Sep 17 00:00:00 2001 From: sachin shinde Date: Tue, 13 Jun 2023 07:09:48 +0000 Subject: [PATCH 1/2] Generated changelog, updated to latest version --- CHANGELOG-ABLY.md | 15 +++++++++++++++ package.json | 2 +- src/connector/ably-connector.ts | 2 +- 3 files changed, 17 insertions(+), 2 deletions(-) diff --git a/CHANGELOG-ABLY.md b/CHANGELOG-ABLY.md index 53247331..e3b7a039 100644 --- a/CHANGELOG-ABLY.md +++ b/CHANGELOG-ABLY.md @@ -1,5 +1,20 @@ # Changelog +## [v1.0.3](https://github.com/ably-forks/laravel-echo/tree/ably-echo-1.0.3) + +[Full Changelog](https://github.com/ably-forks/laravel-echo/compare/ably-echo-1.0.2...ably-echo-1.0.3) + +**Closed issues:** + +- Update/Sync project wrt origin [\#21](https://github.com/ably-forks/laravel-echo/issues/21) + +**Merged pull requests:** + +- Fix/sync fork [\#23](https://github.com/ably-forks/laravel-echo/pull/23) ([sacOO7](https://github.com/sacOO7)) +- Update documentation [\#22](https://github.com/ably-forks/laravel-echo/pull/22) ([sacOO7](https://github.com/sacOO7)) +- Update README ably clientOptions [\#20](https://github.com/ably-forks/laravel-echo/pull/20) ([sacOO7](https://github.com/sacOO7)) +- Replace hosts with env. in clientOptions [\#19](https://github.com/ably-forks/laravel-echo/pull/19) ([sacOO7](https://github.com/sacOO7)) + ## [v1.0.2](https://github.com/ably-forks/laravel-echo/tree/ably-echo-1.0.2) [Full Changelog](https://github.com/ably-forks/laravel-echo/compare/ably-echo-1.0.1...ably-echo-1.0.2) diff --git a/package.json b/package.json index 6375cf2f..0dc0c6ab 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@ably/laravel-echo", - "version": "1.0.2", + "version": "1.0.3", "description": "Laravel Echo library for beautiful Ably integration", "keywords": [ "laravel", diff --git a/src/connector/ably-connector.ts b/src/connector/ably-connector.ts index b31fbb3e..46ab61ad 100644 --- a/src/connector/ably-connector.ts +++ b/src/connector/ably-connector.ts @@ -11,7 +11,7 @@ export class AblyConnector extends Connector { /** * The laravel-echo library version. */ - static LIB_VERSION = '1.0.2'; + static LIB_VERSION = '1.0.3'; /** * The Ably instance. From 04d8ee1c34f724858725cb18bb301be0a59719da Mon Sep 17 00:00:00 2001 From: sachin shinde Date: Tue, 13 Jun 2023 09:53:28 +0000 Subject: [PATCH 2/2] Updated changelog generator --- .github/README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/.github/README.md b/.github/README.md index 2d55d07c..c6b3aefd 100644 --- a/.github/README.md +++ b/.github/README.md @@ -107,15 +107,18 @@ Echo.leaveChannel(echoPresenceChannel.name); ## Release Process This library uses [semantic versioning](http://semver.org/). For each release, the following needs to be done: -1. Create a new branch for the release, named like `release/1.2.4` (where `1.2.4` is what you're releasing, being the new version) +1. Create a new branch for the release, named like `release/1.0.3` (where `1.0.3` is what you're releasing, being the new version). 2. Update the `LIB_VERSION` in `src/connector/ably-connector.ts`. -3. Run `npm version {NEW_VERSION_NUMBER} --no-git-tag-version` -4. Run [`github_changelog_generator`](https://github.com/skywinder/Github-Changelog-Generator) to automate the update of the [CHANGELOG-ABLY.md](../CHANGELOG-ABLY.md). Once the `CHANGELOG-ABLY` update has completed, manually change the `Unreleased` heading and link with the current version number such as `1.2.4`. Also ensure that the `Full Changelog` link points to the new version tag instead of the `HEAD`. +3. Update `version` in `pakckage.json`. +4. Run [`github_changelog_generator`](https://github.com/github-changelog-generator/github-changelog-generator) to automate the update of the [CHANGELOG-ABLY.md](../CHANGELOG-ABLY.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-forks -p laravel-echo --since-tag ably-echo-1.0.3 --output delta.md --token $GITHUB_TOKEN_WITH_REPO_ACCESS`. Generate token [here](https://github.com/settings/tokens/new?description=GitHub%20Changelog%20Generator%20token). + - 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`. 5. Commit generated [CHANGELOG-ABLY.md](../CHANGELOG-ABLY.md) file at root. 6. Make a PR against `main`. 7. Once the PR is approved, merge it into `main`. -8. Add a tag and push it to origin - e.g.: `git tag ably-echo-1.2.4 - && git push origin ably-echo-1.2.4`. +8. Add a tag and push it to origin - e.g.: `git tag ably-echo-1.0.3 && git push origin ably-echo-1.0.3`. 9. Publish npm package on npmjs.com. 10. Visit https://github.com/ably-forks/laravel-echo/tags and add release notes to the release (generally you can just copy the notes you added to the CHANGELOG). 11. Update the [Ably Changelog](https://changelog.ably.com/) (via [headwayapp](https://headwayapp.co/)) with these changes (again, you can just copy the notes you added to the CHANGELOG).