ably-ui 4.5.0 → 5.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +13 -17
  3. data/lib/ably_ui/version.rb +1 -1
  4. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3d09ee8f8796e44d622482646a875cf7fb254f826bc91c1a75e34790765a9003
4
- data.tar.gz: b10b98323ef77ee04454093abec157f846e52ea979c7f68998d5c9f35766adf9
3
+ metadata.gz: 6affdd374453898a61eab4a3b46c740ea6e743f28610753701a1cb370f069a21
4
+ data.tar.gz: c0a099bf76000b63c15dbef975622a5913faa2cdd1dbbffc9d8c74a0e6c0375e
5
5
  SHA512:
6
- metadata.gz: 832c80f2e5c416b1e441b480644f33ddcb4d0aed873a52cf1349494965de5828f94a1d1ff59a67a1e7147438a24f6c211fd506dde0d7170cf2ebe26ff428237b
7
- data.tar.gz: 4c44b03aed8c0463461fffcda4d0c6c71013a1724a2db088b2e36a346d6f8b363692e7737613d1e24c1772f6e4b1d1b2dba3543c4c4ca4595759437fc668cd57
6
+ metadata.gz: 063f4de46d58e22998eb466258b3644d4a153210f46b4d9f5e071a61c15fa6aa27bf097633ede1b906d55b2c2fa7868401ed9f8c4da278472b81c7903a78a93a
7
+ data.tar.gz: a6e7268c83a6938c21bcd2fcd413e7e731088c3029dff0d70c5d660555519955716c10e9f41b3a5a2ce6b8b1f473427d8a24e7082b9d39aedb7575356f3a522d
data/README.md CHANGED
@@ -34,8 +34,6 @@ Each module, apart from components, exposes a `scripts.js`, `styles.css` and `MO
34
34
 
35
35
  This type of installation gives you access to module/components assets as well as React components.
36
36
 
37
- Note, the package is currently hosted in our private GitHub registry, so you will need a `GITHUB_REGISTRY_TOKEN` environment variable in your shell to be able to install it. See [here](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) for instructions on obtaining one.
38
-
39
37
  ```bash
40
38
  npm install @ably/ui
41
39
 
@@ -123,18 +121,9 @@ To use `ably-ui` with [Ruby on Rails](https://rubyonrails.org/) add the `ably-ui
123
121
  ```ruby
124
122
  gem 'ably-ui',
125
123
  '1.0.0',
126
- require: 'ably_ui',
127
- source: 'https://rubygems.pkg.github.com/ably'
128
- ```
129
-
130
- And then run:
131
-
132
- ```bash
133
- bundle config https://rubygems.pkg.github.com/ably USERNAME:TOKEN
124
+ require: 'ably_ui'
134
125
  ```
135
126
 
136
- Where `USERNAME` is your GitHub username (without the `@`) and TOKEN is your [GitHub access token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token). This is required because the gem is downloaded from a private gem registry on GitHub.
137
-
138
127
  Components are exposed as [View Components](https://github.com/github/view_component) and should be available in any view:
139
128
 
140
129
  ```erb
@@ -268,13 +257,20 @@ Then change back `path` to source `source` in the `Gemfile`. If you need to upda
268
257
 
269
258
  Make sure you commit & push your work and remove the [development-specific config](#using-the-development-build-of-ably-ui-in-the-preview-app) before doing this.
270
259
 
271
- You will need to authenticate with the GitHub [NPM registry](https://docs.github.com/en/free-pro-team@latest/packages/using-github-packages-with-your-projects-ecosystem/configuring-npm-for-use-with-github-packages#authenticating-to-github-packages) and [gem registry](https://docs.github.com/en/free-pro-team@latest/packages/using-github-packages-with-your-projects-ecosystem/configuring-rubygems-for-use-with-github-packages#authenticating-with-a-personal-access-token) to publish.
260
+ You will need to authenticate with [npmjs](https://docs.npmjs.com/creating-and-viewing-access-tokens) and [Ruby Gems](https://guides.rubygems.org/api-key-scopes/) to publish.
272
261
 
273
262
  After the above, you should have:
274
263
 
275
- - GITHUB_REGISTRY_TOKEN set in your environment (`.npmrc` will read from it)
276
- - you should do registry login as described in the above docs with your GitHub username and password
277
- - a `~/.gem/credentials` file with a `:github: Bearer TOKEN` (replace GITHUB_REGISTRY_TOKEN with your token - interpolation does not work here)
264
+ - NPM_TOKEN set in your environment
265
+ - `.npmrc` file to read NPM_TOKEN from your environment like this:
266
+ ```
267
+ //registry.npmjs.org/:_authToken=${NPM_TOKEN}
268
+ ```
269
+ - a `~/.gem/credentials` file that has your Rubygems API key:
270
+ ```
271
+ ---
272
+ :rubygems_api_key: REPLACE_THIS_WITH_YOUR_OWN_API_KEY
273
+ ```
278
274
 
279
275
  To deploy a review app with your in-progress code, you can use the `pre-release` script:
280
276
 
@@ -389,7 +385,7 @@ This will trigger GitHub actions in supported apps (currently [Voltaire](http://
389
385
  **To trigger a release:**
390
386
 
391
387
  - Merge your PR into `main`.
392
- - On the Github [Ably-UI](http://github.com/ably/ui) repo, [create a new release](https://github.com/ably/ui/releases/new) tag.
388
+ - On the Github [Ably-UI](http://github.com/ably/ably-ui) repo, [create a new release](https://github.com/ably/ably-ui/releases/new) tag.
393
389
  - Create a new tag with the new version number for the release.
394
390
  - _Do not prefix the tag with a `v`_
395
391
  - Add a meaningful title for the Release.
@@ -1,3 +1,3 @@
1
1
  module AblyUi
2
- VERSION = '4.5.0'
2
+ VERSION = '5.0.0'
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ably-ui
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.5.0
4
+ version: 5.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Dominik Piatek
@@ -10,7 +10,7 @@ authors:
10
10
  autorequire:
11
11
  bindir: bin
12
12
  cert_chain: []
13
- date: 2021-10-25 00:00:00.000000000 Z
13
+ date: 2021-10-26 00:00:00.000000000 Z
14
14
  dependencies:
15
15
  - !ruby/object:Gem::Dependency
16
16
  name: view_component