├── .circleci └── config.yml ├── .eslintrc.js ├── .gitignore ├── README.md ├── package-lock.json ├── package.json ├── public ├── favicon.ico ├── index.html └── manifest.json ├── src ├── App.css ├── App.js ├── App.test.js ├── index.css ├── index.js ├── logo.svg └── registerServiceWorker.js ├── workflow.png └── yarn.lock /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | defaults: &defaults 2 | #working_directory: ./circleci 3 | docker: 4 | - image: circleci/node:8 5 | 6 | version: 2 7 | jobs: 8 | prepare: 9 | <<: *defaults 10 | steps: 11 | - checkout 12 | # Download and cache dependencies 13 | - restore_cache: 14 | keys: 15 | - v1-dependencies-{{ checksum "package.json" }} 16 | - run: npm install 17 | - save_cache: 18 | paths: 19 | - node_modules 20 | key: v1-dependencies-{{ checksum "package.json" }} 21 | - persist_to_workspace: 22 | root: . 23 | paths: 24 | - node_modules 25 | build: 26 | <<: *defaults 27 | steps: 28 | - checkout 29 | - attach_workspace: 30 | at: . 31 | - run: npm run build 32 | - persist_to_workspace: 33 | root: . 34 | paths: 35 | - build 36 | tu: 37 | <<: *defaults 38 | steps: 39 | - checkout 40 | - attach_workspace: 41 | at: . 42 | - run: npm run test 43 | e2e: 44 | <<: *defaults 45 | steps: 46 | - checkout 47 | - attach_workspace: 48 | at: . 49 | - run: npm run test 50 | lint: 51 | <<: *defaults 52 | steps: 53 | - checkout 54 | - attach_workspace: 55 | at: . 56 | - run: npm run lint 57 | deploy-github: 58 | <<: *defaults 59 | steps: 60 | - checkout 61 | - attach_workspace: 62 | at: . 63 | - deploy: 64 | name: Deploy to GitHub Pages 65 | command: | 66 | set -e 67 | 68 | remote=$(git config remote.origin.url) 69 | 70 | if [ ! -d "build" ] 71 | then 72 | echo "build folder not found" 73 | exit 1 74 | fi 75 | 76 | mkdir gh-pages-branch 77 | cd gh-pages-branch 78 | git config --global user.email "$GH_EMAIL" > /dev/null 2>&1 79 | git config --global user.name "$GH_NAME" > /dev/null 2>&1 80 | git init 81 | git remote add --fetch origin "$remote" 82 | 83 | if git rev-parse --verify origin/gh-pages > /dev/null 2>&1 84 | then 85 | git checkout gh-pages 86 | git rm -rf . 87 | else 88 | git checkout --orphan gh-pages 89 | fi 90 | 91 | cp -a "../build/." . 92 | 93 | git add -A 94 | git commit --allow-empty -m "Deploy to GitHub pages [ci skip]" 95 | git push --force --quiet origin gh-pages > /dev/null 2>&1 96 | 97 | cd .. 98 | rm -rf gh-pages-branch 99 | 100 | echo "Finished GitHub pages Deployment!" 101 | 102 | deploy-prod: 103 | <<: *defaults 104 | steps: 105 | - checkout 106 | - attach_workspace: 107 | at: . 108 | - deploy: 109 | name: Deploy to Production 110 | command: | 111 | echo "iooooooo" 112 | 113 | 114 | workflows: 115 | version: 2 116 | build_accept_deploy: 117 | jobs: 118 | - prepare 119 | - lint: 120 | requires: 121 | - prepare 122 | - build: 123 | requires: 124 | - lint 125 | - tu: 126 | requires: 127 | - build 128 | - e2e: 129 | requires: 130 | - build 131 | - deploy-github: 132 | requires: 133 | - tu 134 | - e2e 135 | - deploy-prod: 136 | type: approval 137 | requires: 138 | - tu 139 | - e2e 140 | 141 | 142 | # version: 2 143 | # jobs: 144 | # build: 145 | # branches: 146 | # ignore: 147 | # - gh-pages 148 | # docker: 149 | # - image: circleci/node:8 150 | # working_directory: ~/repo 151 | # steps: 152 | # - checkout 153 | # - restore_cache: 154 | # keys: 155 | # - dependencies-{{ checksum "package.json" }} 156 | # - dependencies- 157 | # - run: 158 | # name: Install dependencies 159 | # command: npm install 160 | # - save_cache: 161 | # paths: 162 | # - node_modules 163 | # key: dependencies-{{ checksum "package.json" }} 164 | # - deploy: 165 | # name: Deploy 166 | # command: | 167 | # set -e 168 | # npm install 169 | # CI="" npm run build 170 | 171 | # remote=$(git config remote.origin.url) 172 | 173 | # siteSource="build" 174 | 175 | # if [ ! -d "build" ] 176 | # then 177 | # echo "Usage: $0 " 178 | # exit 1 179 | # fi 180 | 181 | # mkdir gh-pages-branch 182 | # cd gh-pages-branch 183 | # git config --global user.email "$GH_EMAIL" > /dev/null 2>&1 184 | # git config --global user.name "$GH_NAME" > /dev/null 2>&1 185 | # git init 186 | # git remote add --fetch origin "$remote" 187 | 188 | # if git rev-parse --verify origin/gh-pages > /dev/null 2>&1 189 | # then 190 | # git checkout gh-pages 191 | # git rm -rf . 192 | # else 193 | # git checkout --orphan gh-pages 194 | # fi 195 | 196 | # cp -a "../build/." . 197 | 198 | # git add -A 199 | # git commit --allow-empty -m "Deploy to GitHub pages [ci skip]" 200 | # git push --force --quiet origin gh-pages > /dev/null 2>&1 201 | 202 | # cd .. 203 | # rm -rf gh-pages-branch 204 | 205 | # echo "Finished Deployment!" 206 | -------------------------------------------------------------------------------- /.eslintrc.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | env: { 3 | browser: true, 4 | node: true, 5 | commonjs: true, 6 | es6: true 7 | }, 8 | parser: "babel-eslint", 9 | extends: [ 10 | "eslint:recommended", 11 | "plugin:react/recommended", 12 | "plugin:prettier/recommended", 13 | "plugin:jsx-a11y/recommended" 14 | ], 15 | parserOptions: { 16 | ecmaVersion: 7, 17 | ecmaFeatures: { 18 | experimentalObjectRestSpread: true, 19 | jsx: true 20 | }, 21 | sourceType: "module" 22 | }, 23 | plugins: ["react", "prettier", "jsx-a11y"], 24 | globals: { 25 | React: true, 26 | it: true, 27 | expect: true 28 | }, 29 | rules: { 30 | "prettier/prettier": "warn", 31 | "react/react-in-jsx-scope": "warn", 32 | "react/prop-types": "warn", 33 | "jsx-a11y/click-events-have-key-events": "warn", 34 | "jsx-a11y/no-static-element-interactions": "warn", 35 | "jsx-a11y/accessible-emoji": "warn", 36 | "jsx-a11y/href-no-hash": "warn", 37 | "react/jsx-no-target-blank": "warn", 38 | "react/no-unescaped-entities": "warn", 39 | "react/no-find-dom-node": "warn", 40 | "no-console": "warn", 41 | "no-unused-vars": "warn", 42 | "react/display-name": "off" 43 | } 44 | }; 45 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # See https://help.github.com/ignore-files/ for more about ignoring files. 2 | 3 | # dependencies 4 | /node_modules 5 | 6 | # testing 7 | /coverage 8 | 9 | # production 10 | /build 11 | 12 | # misc 13 | .DS_Store 14 | .env.local 15 | .env.development.local 16 | .env.test.local 17 | .env.production.local 18 | 19 | npm-debug.log* 20 | yarn-debug.log* 21 | yarn-error.log* 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # create-react-app + circleci workflows [![CircleCI](https://circleci.com/gh/revolunet/create-react-app-circleci.svg?style=svg)](https://circleci.com/gh/revolunet/create-react-app-circleci) 2 | 3 | Build, test and deploy your ReactJS application to GitHub pages 4 | 5 | Continuous integration/deployment workflows with CircleCI 6 | 7 | ![workflow](./workflow.png) 8 | 9 | In Circle CI : 10 | - Add a checkout key with write access to the repo 11 | - AddEnvironnements variables to configure on circleci : 12 | - `GH_NAME` : committer who publish the build on gh-pages 13 | - `GH_EMAIL` : committer github email address 14 | 15 | Todo : 16 | - e2e sample tests 17 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "create-react-app-circleci", 3 | "version": "0.1.0", 4 | "homepage": "https://revolunet.github.io/create-react-app-circleci", 5 | "scripts": { 6 | "start": "react-scripts start", 7 | "build": "react-scripts build", 8 | "test": "react-scripts test --env=jsdom", 9 | "eject": "react-scripts eject", 10 | "lint": "eslint src" 11 | }, 12 | "dependencies": { 13 | "react": "^16.3.2", 14 | "react-dom": "^16.3.2", 15 | "react-scripts": "1.1.4" 16 | }, 17 | "devDependencies": { 18 | "enzyme": "^3.3.0", 19 | "enzyme-adapter-react-16": "^1.1.1", 20 | "eslint-config-prettier": "^2.9.0", 21 | "eslint-plugin-prettier": "^2.6.0", 22 | "prettier": "^1.12.1", 23 | "react-test-renderer": "^16.3.2" 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/revolunet/create-react-app-circleci/036c329324abf0788213a059efc7097937513988/public/favicon.ico -------------------------------------------------------------------------------- /public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 11 | 12 | 13 | 22 | React App 23 | 24 | 25 | 28 |
29 | 39 | 40 | 41 | -------------------------------------------------------------------------------- /public/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "short_name": "React App", 3 | "name": "Create React App Sample", 4 | "icons": [ 5 | { 6 | "src": "favicon.ico", 7 | "sizes": "64x64 32x32 24x24 16x16", 8 | "type": "image/x-icon" 9 | } 10 | ], 11 | "start_url": "./index.html", 12 | "display": "standalone", 13 | "theme_color": "#000000", 14 | "background_color": "#ffffff" 15 | } 16 | -------------------------------------------------------------------------------- /src/App.css: -------------------------------------------------------------------------------- 1 | .App { 2 | text-align: center; 3 | } 4 | 5 | .App-logo { 6 | animation: App-logo-spin infinite 20s linear; 7 | height: 80px; 8 | } 9 | 10 | .App-header { 11 | background-color: #222; 12 | height: 150px; 13 | padding: 20px; 14 | color: white; 15 | } 16 | 17 | .App-title { 18 | font-size: 1.5em; 19 | } 20 | 21 | .App-intro { 22 | font-size: large; 23 | } 24 | 25 | @keyframes App-logo-spin { 26 | from { transform: rotate(0deg); } 27 | to { transform: rotate(360deg); } 28 | } 29 | -------------------------------------------------------------------------------- /src/App.js: -------------------------------------------------------------------------------- 1 | import React, { Component } from "react"; 2 | import logo from "./logo.svg"; 3 | import "./App.css"; 4 | 5 | class App extends Component { 6 | render() { 7 | return ( 8 |
9 |
10 | logo 11 |

Welcome to React

12 |
13 |

14 | To get started, edit src/App.js and save to reload. 15 |

16 |
17 | ); 18 | } 19 | } 20 | 21 | export default App; 22 | -------------------------------------------------------------------------------- /src/App.test.js: -------------------------------------------------------------------------------- 1 | import React from "react"; 2 | import ReactDOM from "react-dom"; 3 | import Enzyme, { shallow } from "enzyme"; 4 | import App from "./App"; 5 | 6 | import Adapter from "enzyme-adapter-react-16"; 7 | 8 | Enzyme.configure({ adapter: new Adapter() }); 9 | 10 | it("renders without crashing", () => { 11 | const div = document.createElement("div"); 12 | ReactDOM.render(, div); 13 | ReactDOM.unmountComponentAtNode(div); 14 | }); 15 | 16 | it("is polite", () => { 17 | const wrapper = shallow(); 18 | expect(wrapper.contains("Welcome to React")).toEqual(true); 19 | }); 20 | -------------------------------------------------------------------------------- /src/index.css: -------------------------------------------------------------------------------- 1 | body { 2 | margin: 0; 3 | padding: 0; 4 | font-family: sans-serif; 5 | } 6 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import ReactDOM from 'react-dom'; 3 | import './index.css'; 4 | import App from './App'; 5 | import registerServiceWorker from './registerServiceWorker'; 6 | 7 | ReactDOM.render(, document.getElementById('root')); 8 | registerServiceWorker(); 9 | -------------------------------------------------------------------------------- /src/logo.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /src/registerServiceWorker.js: -------------------------------------------------------------------------------- 1 | // In production, we register a service worker to serve assets from local cache. 2 | 3 | // This lets the app load faster on subsequent visits in production, and gives 4 | // it offline capabilities. However, it also means that developers (and users) 5 | // will only see deployed updates on the "N+1" visit to a page, since previously 6 | // cached resources are updated in the background. 7 | 8 | // To learn more about the benefits of this model, read https://goo.gl/KwvDNy. 9 | // This link also includes instructions on opting out of this behavior. 10 | 11 | const isLocalhost = Boolean( 12 | window.location.hostname === 'localhost' || 13 | // [::1] is the IPv6 localhost address. 14 | window.location.hostname === '[::1]' || 15 | // 127.0.0.1/8 is considered localhost for IPv4. 16 | window.location.hostname.match( 17 | /^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/ 18 | ) 19 | ); 20 | 21 | export default function register() { 22 | if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) { 23 | // The URL constructor is available in all browsers that support SW. 24 | const publicUrl = new URL(process.env.PUBLIC_URL, window.location); 25 | if (publicUrl.origin !== window.location.origin) { 26 | // Our service worker won't work if PUBLIC_URL is on a different origin 27 | // from what our page is served on. This might happen if a CDN is used to 28 | // serve assets; see https://github.com/facebookincubator/create-react-app/issues/2374 29 | return; 30 | } 31 | 32 | window.addEventListener('load', () => { 33 | const swUrl = `${process.env.PUBLIC_URL}/service-worker.js`; 34 | 35 | if (isLocalhost) { 36 | // This is running on localhost. Lets check if a service worker still exists or not. 37 | checkValidServiceWorker(swUrl); 38 | 39 | // Add some additional logging to localhost, pointing developers to the 40 | // service worker/PWA documentation. 41 | navigator.serviceWorker.ready.then(() => { 42 | console.log( 43 | 'This web app is being served cache-first by a service ' + 44 | 'worker. To learn more, visit https://goo.gl/SC7cgQ' 45 | ); 46 | }); 47 | } else { 48 | // Is not local host. Just register service worker 49 | registerValidSW(swUrl); 50 | } 51 | }); 52 | } 53 | } 54 | 55 | function registerValidSW(swUrl) { 56 | navigator.serviceWorker 57 | .register(swUrl) 58 | .then(registration => { 59 | registration.onupdatefound = () => { 60 | const installingWorker = registration.installing; 61 | installingWorker.onstatechange = () => { 62 | if (installingWorker.state === 'installed') { 63 | if (navigator.serviceWorker.controller) { 64 | // At this point, the old content will have been purged and 65 | // the fresh content will have been added to the cache. 66 | // It's the perfect time to display a "New content is 67 | // available; please refresh." message in your web app. 68 | console.log('New content is available; please refresh.'); 69 | } else { 70 | // At this point, everything has been precached. 71 | // It's the perfect time to display a 72 | // "Content is cached for offline use." message. 73 | console.log('Content is cached for offline use.'); 74 | } 75 | } 76 | }; 77 | }; 78 | }) 79 | .catch(error => { 80 | console.error('Error during service worker registration:', error); 81 | }); 82 | } 83 | 84 | function checkValidServiceWorker(swUrl) { 85 | // Check if the service worker can be found. If it can't reload the page. 86 | fetch(swUrl) 87 | .then(response => { 88 | // Ensure service worker exists, and that we really are getting a JS file. 89 | if ( 90 | response.status === 404 || 91 | response.headers.get('content-type').indexOf('javascript') === -1 92 | ) { 93 | // No service worker found. Probably a different app. Reload the page. 94 | navigator.serviceWorker.ready.then(registration => { 95 | registration.unregister().then(() => { 96 | window.location.reload(); 97 | }); 98 | }); 99 | } else { 100 | // Service worker found. Proceed as normal. 101 | registerValidSW(swUrl); 102 | } 103 | }) 104 | .catch(() => { 105 | console.log( 106 | 'No internet connection found. App is running in offline mode.' 107 | ); 108 | }); 109 | } 110 | 111 | export function unregister() { 112 | if ('serviceWorker' in navigator) { 113 | navigator.serviceWorker.ready.then(registration => { 114 | registration.unregister(); 115 | }); 116 | } 117 | } 118 | -------------------------------------------------------------------------------- /workflow.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/revolunet/create-react-app-circleci/036c329324abf0788213a059efc7097937513988/workflow.png --------------------------------------------------------------------------------