From 7f9ecb7e7b8e45717f9e1a7bf79b64cdebe6891f Mon Sep 17 00:00:00 2001 From: Beni Cherniavsky-Paskin Date: Fri, 12 Jul 2019 18:31:28 +0300 Subject: [PATCH 1/2] README: details about running locally and Netlify deploys --- readme.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/readme.md b/readme.md index 128cf50..5b322be 100755 --- a/readme.md +++ b/readme.md @@ -44,6 +44,31 @@ javascript: (function() { You can use Git History for local git repos with the [CLI](https://github.com/pomber/git-history/tree/master/cli) or with the [VS Code extension](https://marketplace.visualstudio.com/items?itemName=pomber.git-file-history). +## Hacking + +To run from local checkout: + + yarn install + yarn start + +it'll open the starting page in browser, you'll want to append the path that comes after `https://github.com/` + +### Netlify deploys + +Once you submit a PR to `pomber/git-history` repo, Netlify will try to build it a deploy a publicly accessible preview domain such as https://deploy-preview-137--github-history.netlify.com/. +To get the preview URL, look for "deploy/netlify Deploy preview ready!" line, click on "Details" link to its right. +It will also get updated on each push to the PR branch. + +If you want to set up hosting and public previews for branches of your fork *before* you submit a PR: + +1. Go to https://app.netlify.com/. +2. Login with GitHub. +3. Click "New site from Git" button. + It'll likely prompt you to give Netlify some access to your repos. +4. Choose your fork of this repo. +5. Under "Build & deploy" settings, set Build command to `yarn build` and Publish directory to `build`. +6. Under "Deploy contexts", configure which branches to build. + ## Support Git History ### Sponsors From 87aae1b17e6a4e26bd3b1fc33ce63f5acbce79fb Mon Sep 17 00:00:00 2001 From: Beni Cherniavsky-Paskin Date: Sun, 14 Jul 2019 12:09:36 +0300 Subject: [PATCH 2/2] Fix lint, Document testing & lint ;-) --- readme.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 5b322be..4f0bd4c 100755 --- a/readme.md +++ b/readme.md @@ -14,7 +14,7 @@ Quickly browse the history of files in any git repo: [Try it](https://github.githistory.xyz/babel/babel/blob/master/packages/babel-core/test/browserify.js) -> If you like this project consider [backing my open source work on Patreon!](https://patreon.com/pomber) +> If you like this project consider [backing my open source work on Patreon!](https://patreon.com/pomber) > And follow [@pomber](https://twitter.com/pomber) on twitter for updates. ## Extensions @@ -53,13 +53,23 @@ To run from local checkout: it'll open the starting page in browser, you'll want to append the path that comes after `https://github.com/` +### Testing & linting + + yarn test + +It stays running watching for source changes, press w for help, q to quit. + +If it says "Code style issues found in the above file(s). Forgot to run Prettier?", run: + + yarn format + ### Netlify deploys Once you submit a PR to `pomber/git-history` repo, Netlify will try to build it a deploy a publicly accessible preview domain such as https://deploy-preview-137--github-history.netlify.com/. To get the preview URL, look for "deploy/netlify Deploy preview ready!" line, click on "Details" link to its right. It will also get updated on each push to the PR branch. -If you want to set up hosting and public previews for branches of your fork *before* you submit a PR: +If you want to set up hosting and public previews for branches of your fork _before_ you submit a PR: 1. Go to https://app.netlify.com/. 2. Login with GitHub.