Skip to content

Commit

Permalink
Update Spotify SDKS
Browse files Browse the repository at this point in the history
- Update SDKs
- Update Readme with sdk badges
- Update Contributing
- Update Changelog
- Add dependabot configuration
  • Loading branch information
cjam committed Oct 17, 2021
1 parent 8fc72e3 commit 27cd717
Show file tree
Hide file tree
Showing 6 changed files with 156 additions and 117 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Update

- Update Spotify SDKS (again)
- Update [Readme](./README) with SDK Version Badges
- Update [Contributing Guide](./CONTRIBUTING)
- Add Dependabot configuration

## [0.3.11-0] - 2021-10-13

### Update
Expand Down
52 changes: 32 additions & 20 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,29 @@
# Contributing

Contributions are welcome in any form. Fork the repo and issue a PR. It's a pretty lean team ([me](https://github.com/cjam)) at the moment so I'm focusing on code over documentation.

Contributions are welcome in any form. Fork the repo and issue a PR. It's a pretty lean team ([me](https://github.com/cjam)) at the moment so I'm focusing on code over documentation.

The following is a guide mostly for me so next time I come back to this project I know how to work with it.

### Development

Developing this library is most easily done with the [Example Project](./example). Since we need Spotify on the device to verify functionality, the recommended approach is to add UI to the main screen that exercises the API, making functionality easy to verify and debug.
Developing this library is most easily done with the [Example Project](./example). Since we need Spotify on the device to verify functionality, the recommended approach is to add UI to the main screen that exercises the API, making functionality easy to verify and debug.

In order for the example app to function correctly, there are a few things that need to be setup:

#### Install Dependencies

You must run `yarn` in:

- repo root
- `example/`
- `example-server/`

You must run `pod install` in `example/ios/`

#### Example Server Environment

- Need a `.env` file in the root of this folder with the following contents:

```env
SPOTIFY_CLIENT_ID="<Your_Client_App_ID>"
SPOTIFY_REDIRECT_URL="example://spotify-login-callback"
Expand All @@ -36,37 +39,46 @@ From repo root run `yarn example`

Changes in the `react-native-spotify-remote` package (i.e. modifying the api or Typescript) should be automatically reloaded within the example app.

### Updating Spotify iOS SDK
### Updating External Spotify SDK's

```sh
cd ./ios/external/SpotifySDK/ && git checkout v<tagged_version>
```
Then commit the change to the `SpotifySDK` folder.
1. Update SDKS
#### Update Both SDK's to latest
```sh
git submodule update --remote --merge
```
**OR**
#### Update One SDK to specific commit
```sh
cd ./ios/external/SpotifySDK/ && git checkout v<tagged_version>
```
2. Update badges in [Readme](./README)

- Update the version in the Badge
- Update the links to the correct commit

3. Commit changes

### Publishing
Unfortunately, this package doesn't yet have Continuous Deployment setup:

Unfortunately, this package doesn't yet have Continuous Deployment setup but it does have an automated release script.

To release a new version of the package:

- Bump version number in [package.json](./package.json) using [Semantic Versioning](https://docs.npmjs.com/about-semantic-versioning)
- Verify package contents `npm publish --dry-run`
- Commit all changes (i.e. new docs etc)
- Update [`Change Log`](./CHANGELOG.md) with release version and date
- Merge in changes
- Tag master with `v<version_number>`
- `git checkout v<version_number>`
- run `npm publish`
- Make sure the _Unreleased_ section in [Changelog](./CHANGELOG) has been updated with changes
- Update any contributors (see below for adding contributors)
- Make sure all changes have been committed
- run `yarn release-it` and follow instructions

### Adding Contributors

This repo uses the [all contributors cli](https://allcontributors.org/docs/en/cli/usage) to maintain contributor lists in the readme.

- Finding missing ones can be done via

`yarn all-contributors check`
`yarn all-contributors check` (isn't super reliable)

- Add contributor
`yarn all-contributors add`
`yarn all-contributors add`

- Generate Readme
`yarn all-contributors generate`
`yarn all-contributors generate`
Loading

0 comments on commit 27cd717

Please sign in to comment.