Skip to content

Commit 6ee71e2

Browse files
Fix docs
Add release command to justfile
1 parent fa3d60a commit 6ee71e2

File tree

12 files changed

+105
-49
lines changed

12 files changed

+105
-49
lines changed

.justfile

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,21 @@
11
alias b := build
2+
alias r := release
23

34
alias d := docs
45
alias od := open-docs
56

6-
build:
7+
build: docs
78
yarn prepare
89

910
docs:
1011
yarn docs
1112

1213
open-docs: docs
1314
open docs/index.html
15+
16+
release: docs
17+
npm publish --dry-run
18+
@echo "THIS IS DRY RUN. Check if everything is ok and then run 'npm publish'. Checklist:"
19+
@echo "\t- check the release steps in CONTRIBUTING"
20+
@echo "\t- docs are up to date"
21+

CONTRIBUTING.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,12 @@
1818

1919
3. Update CHANGELOG.md
2020
4. Update badge in README.md
21-
5. Commit
22-
5. Create a version tag
23-
6. Push branch and tags
24-
7. Create a Github repo release
21+
5. Do the release dry run with `just release` and verify that the release is correct (checklist is in the command output)
22+
6. Commit and merge to master
23+
7. Create and push a new version tag
24+
8. Run `npm publish` to publish the package to npm
25+
9. Create a Github repo release
2526
- Release title should be the current version tag
26-
8. `yarn release`
27-
- will generate docs
28-
9. `yarn npm publish`
2927

3028
### How to change build config
3129

docs/classes/HyperTrack.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>HyperTrack | HyperTrack React Native SDK API - v9.0.0</title><meta name="description" content="Documentation for HyperTrack React Native SDK API - v9.0.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>HyperTrack | HyperTrack React Native SDK API - v9.1.0</title><meta name="description" content="Documentation for HyperTrack React Native SDK API - v9.1.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
22
<div class="tsd-toolbar-contents container">
33
<div class="table-cell" id="tsd-search" data-base="..">
44
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
55
<div class="field">
66
<div id="tsd-toolbar-links"></div></div>
77
<ul class="results">
88
<li class="state loading">Preparing search index...</li>
9-
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">HyperTrack React Native SDK API - v9.0.0</a></div>
9+
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">HyperTrack React Native SDK API - v9.1.0</a></div>
1010
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
1111
<div class="container container-main">
1212
<div class="col-8 col-content">
1313
<div class="tsd-page-title">
1414
<ul class="tsd-breadcrumb">
15-
<li><a href="../modules.html">HyperTrack React Native SDK API - v9.0.0</a></li>
15+
<li><a href="../modules.html">HyperTrack React Native SDK API - v9.1.0</a></li>
1616
<li><a href="HyperTrack.html">HyperTrack</a></li></ul>
1717
<h1>Class HyperTrack</h1></div>
1818
<section class="tsd-panel tsd-hierarchy">
@@ -299,7 +299,7 @@ <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option
299299
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
300300
<div class="tsd-accordion-details">
301301
<ul>
302-
<li><a href="../modules.html">Hyper<wbr/>Track <wbr/>React <wbr/>Native SDK API -<wbr/> v9.0.0</a>
302+
<li><a href="../modules.html">Hyper<wbr/>Track <wbr/>React <wbr/>Native SDK API -<wbr/> v9.1.0</a>
303303
<ul></ul></li></ul></div></details></nav>
304304
<nav class="tsd-navigation secondary menu-sticky">
305305
<ul>

docs/enums/HyperTrackError.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>HyperTrackError | HyperTrack React Native SDK API - v9.0.0</title><meta name="description" content="Documentation for HyperTrack React Native SDK API - v9.0.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>HyperTrackError | HyperTrack React Native SDK API - v9.1.0</title><meta name="description" content="Documentation for HyperTrack React Native SDK API - v9.1.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
22
<div class="tsd-toolbar-contents container">
33
<div class="table-cell" id="tsd-search" data-base="..">
44
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
55
<div class="field">
66
<div id="tsd-toolbar-links"></div></div>
77
<ul class="results">
88
<li class="state loading">Preparing search index...</li>
9-
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">HyperTrack React Native SDK API - v9.0.0</a></div>
9+
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">HyperTrack React Native SDK API - v9.1.0</a></div>
1010
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
1111
<div class="container container-main">
1212
<div class="col-8 col-content">
1313
<div class="tsd-page-title">
1414
<ul class="tsd-breadcrumb">
15-
<li><a href="../modules.html">HyperTrack React Native SDK API - v9.0.0</a></li>
15+
<li><a href="../modules.html">HyperTrack React Native SDK API - v9.1.0</a></li>
1616
<li><a href="HyperTrackError.html">HyperTrackError</a></li></ul>
1717
<h1>Enumeration HyperTrackError</h1></div>
1818
<section class="tsd-panel-group tsd-index-group">
@@ -116,7 +116,7 @@ <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option
116116
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
117117
<div class="tsd-accordion-details">
118118
<ul>
119-
<li><a href="../modules.html">Hyper<wbr/>Track <wbr/>React <wbr/>Native SDK API -<wbr/> v9.0.0</a>
119+
<li><a href="../modules.html">Hyper<wbr/>Track <wbr/>React <wbr/>Native SDK API -<wbr/> v9.1.0</a>
120120
<ul></ul></li></ul></div></details></nav>
121121
<nav class="tsd-navigation secondary menu-sticky">
122122
<ul>

docs/index.html

Lines changed: 55 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,68 @@
1-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>HyperTrack React Native SDK API - v9.0.0</title><meta name="description" content="Documentation for HyperTrack React Native SDK API - v9.0.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
1+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>HyperTrack React Native SDK API - v9.1.0</title><meta name="description" content="Documentation for HyperTrack React Native SDK API - v9.1.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
22
<div class="tsd-toolbar-contents container">
33
<div class="table-cell" id="tsd-search" data-base=".">
44
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
55
<div class="field">
66
<div id="tsd-toolbar-links"></div></div>
77
<ul class="results">
88
<li class="state loading">Preparing search index...</li>
9-
<li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">HyperTrack React Native SDK API - v9.0.0</a></div>
9+
<li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">HyperTrack React Native SDK API - v9.1.0</a></div>
1010
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
1111
<div class="container container-main">
1212
<div class="col-8 col-content">
1313
<div class="tsd-page-title">
14-
<h2>HyperTrack React Native SDK API - v9.0.0</h2></div>
15-
<div class="tsd-panel tsd-typography"></div></div>
14+
<h2>HyperTrack React Native SDK API - v9.1.0</h2></div>
15+
<div class="tsd-panel tsd-typography">
16+
<a href="#react-native-hypertrack-sdk" id="react-native-hypertrack-sdk" style="color: inherit; text-decoration: none;">
17+
<h1>React Native HyperTrack SDK</h1>
18+
</a>
19+
<p><img src="https://img.shields.io/github/license/hypertrack/sdk-react-native.svg" alt="GitHub">
20+
<img src="https://img.shields.io/npm/v/hypertrack-sdk-react-native.svg" alt="npm">
21+
<img src="https://img.shields.io/badge/iOS%20SDK-4.14.0-brightgreen.svg" alt="iOS SDK">
22+
<img src="https://img.shields.io/badge/Android%20SDK-6.4.0-brightgreen.svg" alt="Android SDK"></p>
23+
<p><a href="https://www.hypertrack.com">HyperTrack</a> lets you add live location tracking to your mobile app. Live location is made available along with ongoing activity, tracking controls and tracking outage with reasons.</p>
24+
<p>React Native HyperTrack SDK is a wrapper around native iOS and Android SDKs that allows to integrate HyperTrack into React Native apps.</p>
25+
<p>For information about how to get started with React Native HyperTrack SDK, please check this <a href="https://www.hypertrack.com/docs/install-sdk-react-native">Guide</a>.</p>
26+
27+
<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
28+
<h2>Installation</h2>
29+
</a>
30+
<p><code>yarn add hypertrack-sdk-react-native</code></p>
31+
32+
<a href="#sample-code" id="sample-code" style="color: inherit; text-decoration: none;">
33+
<h2>Sample code</h2>
34+
</a>
35+
<p><a href="https://github.com/hypertrack/quickstart-react-native">Quickstart React Native app</a></p>
36+
37+
<a href="#wrapper-api-documentation" id="wrapper-api-documentation" style="color: inherit; text-decoration: none;">
38+
<h2>Wrapper API Documentation</h2>
39+
</a>
40+
<p><a href="https://hypertrack.github.io/sdk-react-native/">Wrapper API Documentation</a></p>
41+
42+
<a href="#requirements" id="requirements" style="color: inherit; text-decoration: none;">
43+
<h2>Requirements</h2>
44+
</a>
45+
46+
<a href="#android" id="android" style="color: inherit; text-decoration: none;">
47+
<h3>Android</h3>
48+
</a>
49+
<ul>
50+
<li>Gradle version 6.7.1+</li>
51+
<li>compileSdkVersion 31+</li>
52+
</ul>
53+
54+
<a href="#ios" id="ios" style="color: inherit; text-decoration: none;">
55+
<h3>iOS</h3>
56+
</a>
57+
<ul>
58+
<li>iOS version 12.4+</li>
59+
</ul>
60+
61+
<a href="#contributing" id="contributing" style="color: inherit; text-decoration: none;">
62+
<h2>Contributing</h2>
63+
</a>
64+
<p>If you want to contribute check <a href="CONTRIBUTING.md">CONTRIBUTING.md</a></p>
65+
</div></div>
1666
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
1767
<div class="tsd-navigation settings">
1868
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -32,7 +82,7 @@ <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option
3282
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
3383
<div class="tsd-accordion-details">
3484
<ul>
35-
<li class="current selected"><a href="modules.html">Hyper<wbr/>Track <wbr/>React <wbr/>Native SDK API -<wbr/> v9.0.0</a>
85+
<li class="current selected"><a href="modules.html">Hyper<wbr/>Track <wbr/>React <wbr/>Native SDK API -<wbr/> v9.1.0</a>
3686
<ul></ul></li></ul></div></details></nav>
3787
<nav class="tsd-navigation secondary menu-sticky">
3888
<ul>

0 commit comments

Comments
 (0)