Skip to content

Commit

Permalink
Merge pull request #24 from ably-forks/v1.0.3
Browse files Browse the repository at this point in the history
Release 1.0.3
  • Loading branch information
sacOO7 authored Jun 13, 2023
2 parents 89bc91a + 04d8ee1 commit 85f4dbc
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 7 deletions.
13 changes: 8 additions & 5 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
15 changes: 15 additions & 0 deletions CHANGELOG-ABLY.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
2 changes: 1 addition & 1 deletion src/connector/ably-connector.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 85f4dbc

Please sign in to comment.