Merge branch 'release/0.1.2'

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.1.1
+current_version = 0.1.2
 tag_name = {new_version}
 commit = True
 tag = True

.github/workflows/movie-box.yml

@@ -1,9 +1,11 @@
 name: movie-box
 on:
-  schedule:
-    - cron: '0 * * * *'
   push:
     branches: master
+  schedule:
+    - cron: '0 * * * *'
+  watch:
+    types: [started]
 jobs:
   moviebox:
    runs-on: ubuntu-latest

HISTORY.md

@@ -1,6 +1,32 @@
 # Changelog
 
 
+## 0.1.2 (2020-04-06)
+
+### Changes
+
+* Updating instructions. [Luis Alejandro Martínez Faneyth]
+
+* Adding option to trigger action run with a star. [Luis Alejandro Martínez Faneyth]
+
+### Other
+
+* Update index.js. [Luis Alejandro Martínez Faneyth]
+
+* Bump @octokit/rest from 16.32.0 to 17.1.4. [dependabot-preview[bot]]
+
+  Bumps [@octokit/rest](https://github.com/octokit/rest.js) from 16.32.0 to 17.1.4.
+  - [Release notes](https://github.com/octokit/rest.js/releases)
+  - [Commits](https://github.com/octokit/rest.js/compare/v16.32.0...v17.1.4)
+
+* Bump dotenv from 8.1.0 to 8.2.0. [dependabot-preview[bot]]
+
+  Bumps [dotenv](https://github.com/motdotla/dotenv) from 8.1.0 to 8.2.0.
+  - [Release notes](https://github.com/motdotla/dotenv/releases)
+  - [Changelog](https://github.com/motdotla/dotenv/blob/master/CHANGELOG.md)
+  - [Commits](https://github.com/motdotla/dotenv/compare/v8.1.0...v8.2.0)
+
+
 ## 0.1.1 (2020-04-05)
 
 ### Changes

README.md

@@ -11,14 +11,16 @@
 This code was heavily inspired by [@jacc's music-box](https://github.com/jacc/music-box).
 
 ## 🎒 Prep Work
-1. Create a new public GitHub Gist (https://gist.github.com/)
-1. Create a token with the `gist` scope and copy it. (https://github.com/settings/tokens/new)
-1. Create a Trakt.tv Application (https://trakt.tv/oauth/applications/new)
-1. Copy the `API token`
+1. Create a new public GitHub Gist (https://gist.github.com/).
+2. Create a token with the `gist` scope and copy it. (https://github.com/settings/tokens/new).
+3. Create a Trakt.tv Application (https://trakt.tv/oauth/applications/new).
+4. Copy the `API token`.
 
 ## 🖥 Project Setup
-1. Fork this repo
-2. Go to your fork's `Settings` > `Secrets` > `Add a new secret` for each environment secret (below)
+1. Fork this repo.
+2. Go to your fork's `Settings` > `Secrets` > `Add a new secret` for each environment secret (below).
+3. Activate github workflows on `Actions` > `I understand my workflows, go ahead and run them`.
+4. Star your own fork to trigger the initial build. Then the gist will update hourly. You can then go to your profile and pin the gist.
 
 ## 🤫 Environment Secrets
 - **GIST_ID:** The ID portion from your gist url `https://gist.github.com/<github username>/`**`<gist ID>`**.
@@ -29,7 +31,7 @@ This code was heavily inspired by [@jacc's music-box](https://github.com/jacc/mu
 
 ## 🕵🏾 Hacking suggestions
 
-- You can set up CI on Travis if you want to modify this Github Action. You just have to configure the environment secrets as environment variables on travis. A build will be triggered on every push for the `develop` branch. Careful, your gist WILL be updated.
+- You can set up CI on Travis if you want to modify this Github Action. You just have to configure the environment secrets as environment variables on Travis. A build will be triggered on every push for the `develop` branch. Careful, your gist WILL be updated.
 - You can also test the script locally with Lando and Docker:
 
   * Install [Docker Community Edition](https://docs.docker.com/install/#supported-platforms) according with your operating system
@@ -46,6 +48,14 @@ This code was heavily inspired by [@jacc's music-box](https://github.com/jacc/mu
 
           git branch develop
 
+  * Create a `.env` file with the content of the environment secrets as variables, like this (with real values):
+
+          GIST_ID=xxxx
+          GH_TOKEN=xxxx
+          TRAKT_ID=xxxx
+          TRAKT_USERNAME=xxxx
+          MOVIE_BOX_MODE=xxxx
+
   * Execute the following command to create the docker image (first time only):
 
           make image

index.js

@@ -1,5 +1,5 @@
 require('dotenv').config();
-const Octokit = require("@octokit/rest");
+const { Octokit } = require("@octokit/rest");
 const fetch = require("node-fetch");
 const eaw = require('eastasianwidth');
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "movie-box",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Update a gist to contain your recently watched movies from trakt.tv.",
   "author": "Luis Alejandro Martínez Faneyth <[email protected]>",
   "license": "GPL-3.0-or-later",
@@ -17,8 +17,8 @@
     "update": "node index.js"
   },
   "dependencies": {
-    "@octokit/rest": "16.32.0",
-    "dotenv": "8.1.0",
+    "@octokit/rest": "17.1.4",
+    "dotenv": "8.2.0",
     "eastasianwidth": "0.2.0",
     "gist-box": "0.3.0",
     "octokit": "1.0.0-hello-world"