diff --git a/.justfile b/.justfile new file mode 100644 index 0000000..62e744d --- /dev/null +++ b/.justfile @@ -0,0 +1,8 @@ +docs: + npm run docgen + +release: docs + npm publish --dry-run + @echo "THIS IS DRY RUN. Check if everything is ok and then run 'npm publish'. Checklist:" + @echo "\t- check the release steps in CONTRIBUTING" + @echo "\t- docs are up to date" diff --git a/CHANGELOG.md b/CHANGELOG.md index aa8933c..52ffc26 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [1.0.1] - 2023-06-01 + +### Changed +- HyperTrack SDK iOS updated to 4.16.0 + ## [1.0.0] - 2023-02-10 -#### Added -- Initial release \ No newline at end of file +### Added +- Initial release + +[1.0.1] https://github.com/hypertrack/sdk-ionic-capacitor/releases/tag/1.0.1 +[1.0.0] https://github.com/hypertrack/sdk-ionic-capacitor/releases/tag/1.0.0 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c250b7a..1f1ee73 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,17 +14,26 @@ - `s.dependency 'HyperTrack'` 2. Increment wrapper version + - `package.json` - `version` + 3. Update CHANGELOG.md + + - Add the release link to the bottom + 4. Update badge in README.md -5. Commit -5. Create a version tag -6. Push branch and tags -7. Create a Github repo release + +5. Do the release dry run with `just release` and verify that the release is correct (checklist is in the command output) + +6. Commit and merge to master + +7. Create and push a new version tag + +8. Create a Github repo release - Release title should be the current version tag -8. `npm release` -9. `npm publish` + +9. Run `npm publish` to publish the package to npm ## Scripts diff --git a/HypertrackSdkIonicCapacitor.podspec b/HypertrackSdkIonicCapacitor.podspec index d1e2607..a9c1fb4 100644 --- a/HypertrackSdkIonicCapacitor.podspec +++ b/HypertrackSdkIonicCapacitor.podspec @@ -14,5 +14,5 @@ Pod::Spec.new do |s| s.ios.deployment_target = '12.0' s.dependency 'Capacitor' s.swift_version = '5.1' - s.dependency 'HyperTrack','4.14.0' + s.dependency 'HyperTrack','4.16.0' end diff --git a/docs/classes/HyperTrack.html b/docs/classes/HyperTrack.html index 38adbd3..91a24ab 100644 --- a/docs/classes/HyperTrack.html +++ b/docs/classes/HyperTrack.html @@ -1,4 +1,4 @@ -HyperTrack | HyperTrack Ionic Capacitor SDK API - v1.0.0
+HyperTrack | HyperTrack Ionic Capacitor SDK API - v1.0.1
  • Preparing search index...
  • -
  • The search index is not available
HyperTrack Ionic Capacitor SDK API - v1.0.0
+
  • The search index is not available
  • HyperTrack Ionic Capacitor SDK API - v1.0.1
    @@ -296,7 +296,7 @@

    Theme

    @@ -6,13 +6,13 @@
    HyperTrack Ionic Capacitor SDK API - v1.0.0 +
  • The search index is not available
  • HyperTrack Ionic Capacitor SDK API - v1.0.1
    @@ -116,7 +116,7 @@

    Theme

    @@ -6,12 +6,12 @@
    HyperTrack Ionic Capacitor SDK API - v1.0.0 +
  • The search index is not available
  • HyperTrack Ionic Capacitor SDK API - v1.0.1
    -

    HyperTrack Ionic Capacitor SDK API - v1.0.0

    +

    HyperTrack Ionic Capacitor SDK API - v1.0.1

    @@ -65,7 +65,7 @@

    Theme

    @@ -6,13 +6,13 @@ HyperTrack Ionic Capacitor SDK API - v1.0.0 +
  • The search index is not available
  • HyperTrack Ionic Capacitor SDK API - v1.0.1
    @@ -60,7 +60,7 @@

    Theme

    @@ -6,13 +6,13 @@
    HyperTrack Ionic Capacitor SDK API - v1.0.0 +
  • The search index is not available
  • HyperTrack Ionic Capacitor SDK API - v1.0.1
    Errors: {
        type: "errors";
        value: HyperTrackError[];
    }
    @@ -42,7 +42,7 @@

    Theme

    @@ -6,13 +6,13 @@
    HyperTrack Ionic Capacitor SDK API - v1.0.0 +
  • The search index is not available
  • HyperTrack Ionic Capacitor SDK API - v1.0.1
    Location: {
        type: "location";
        value: {
            latitude: number;
            longitude: number;
        };
    }
    @@ -47,7 +47,7 @@

    Theme

    @@ -6,13 +6,13 @@
    HyperTrack Ionic Capacitor SDK API - v1.0.0 +
  • The search index is not available
  • HyperTrack Ionic Capacitor SDK API - v1.0.1
    LocationError: NotRunning | Starting | Errors
    @@ -35,7 +35,7 @@

    Theme

    @@ -6,13 +6,13 @@ HyperTrack Ionic Capacitor SDK API - v1.0.0 +
  • The search index is not available
  • HyperTrack Ionic Capacitor SDK API - v1.0.1
    NotRunning: {
        type: "notRunning";
    }
    @@ -40,7 +40,7 @@

    Theme

    @@ -6,13 +6,13 @@
    HyperTrack Ionic Capacitor SDK API - v1.0.0 +
  • The search index is not available
  • HyperTrack Ionic Capacitor SDK API - v1.0.1
    SdkInitParams: {
        loggingEnabled?: boolean;
        allowMockLocations?: boolean;
        requireBackgroundTrackingPermission?: boolean;
    }
    @@ -44,7 +44,7 @@

    Theme

    @@ -6,13 +6,13 @@
    HyperTrack Ionic Capacitor SDK API - v1.0.0 +
  • The search index is not available
  • HyperTrack Ionic Capacitor SDK API - v1.0.1
    Starting: {
        type: "starting";
    }
    @@ -40,7 +40,7 @@

    Theme