CI: Add automatic Github Pages deployment #143

nalinbhardwaj · 2017-12-03T12:44:41Z

Automates Github Pages deployment by making travis commit any changes to master to gh-pages branch, and other branch changes to gh-pages-branch/"original branch name"

Currently, you can see it works on my fork. For example, commits to master automatically get pushed to gh-pages and deployed on my website http://nibnalin.me/coala-html/#/ . Branch CI-testing gets built and pushed to gh-pages-branch/CI-testing. Note that the original issue mentions using gh-pages/<branch name> but that couldn't be done since git would error out due to existence of gh-pages branch.

data folder used for building the website has to of course now be moved to master(I've done that), and the failing tests are unrelated to my PR, and have already been verified to fail on clean master by @Mixih

TODO: I would require an owner to provide a deploy key.

Closes #133

For short term contributors: we understand that getting your commits well
defined like we require is a hard task and takes some learning. If you
look to help without wanting to contribute long term there's no need
for you to learn this. Just drop us a message and we'll take care of brushing
up your stuff for merge!

Checklist

I read the commit guidelines and I've followed
them.
I ran coala over my code locally. (All commits have to pass
individually. It is not sufficient to have "fixup commits" on your PR,
our bot will still report the issues for the previous commit.) You will
likely receive a lot of bot comments and build failures if coala does not
pass on every single commit!

After you submit your pull request, DO NOT click the 'Update Branch' button.
When asked for a rebase, consult coala.io/rebase
instead.

Please consider helping us by reviewing other peoples pull requests as well:

pick up any PR at https://coala.io/review
review it (check https://coala.io/reviewing for more info)
if you are sure that it needs work, use cobot mark wip <URL> to get it out
of the review queue.

The more you review, the more your score will grow at coala.io and we will
review your PRs faster!

yukiisbored

A couple of problems.

Please use Travis-CI GitHub pages deployment feature: https://docs.travis-ci.com/user/deployment/pages/
Your diff is so huge for such a simple thing, please remove the unnecessary stuff.

yukiisbored · 2017-12-03T13:23:45Z

deack 454fe03

nalinbhardwaj · 2017-12-03T13:36:30Z

@yukiisbored Can you elaborate on the 2nd point? Most of the diff comes from putting the ‘data’ folder from gh-pages branch in master. I’ve only modified 2 files, .travis.yml and .ci/deploy.sh .
The reason behind putting data here is to allow easy change of data to use to build gh-pages, otherwise you would earlier have to rebuild it manually on changing data.
Regarding 1, I’ll check that out but currently coala/community seems to have a similar deployment system. Should that be changed as well? Also, I think I read online that the way I(and community repo) do it is more secure/modular?

yukiisbored · 2017-12-03T14:15:46Z

@nalinbhardwaj About coala/community, no idea, @jayvdb probably didn't know about Travis CI GitHub Pages deployment feature. Anyway about the Data folder, didn't notice those are coala json output since I reviewed from my phone. But, can you confirm deployment go smoothly since it looks like the data folder isn't inside the public/ folder which won't be part of the deployed site.

nalinbhardwaj · 2017-12-03T14:21:44Z

Yep @yukiisbored deployment is currently smooth and fine with data where it is. If you want however I can move it to some other directory?

Also there’s a problem with the Travis Github pages building, since it’s a yaml file, I don’t think we can do stuff like pushing to custom branch(as I require for this issue) like master pushes to gh-pages but any other branch “xyz” pushes to gh-pages-branch/xyz ?

yukiisbored · 2017-12-03T14:22:34Z

@nalinbhardwaj see https://docs.travis-ci.com/user/deployment/pages/

yukiisbored · 2017-12-03T14:26:00Z

Also, If you want to see an example: https://github.com/yukiisbored/blog-archive/blob/blog/.travis.yml

Asked other maintainers, seems like we prefer ssh deploy keys.

yukiisbored · 2017-12-03T14:52:47Z

@nalinbhardwaj just asked @jayvdb, it seems SSH deploy keys are preferred so I'm gonna merge this, but I need to setup the deploy keys.

yukiisbored · 2017-12-03T14:57:59Z

.travis.yml

@@ -32,6 +39,8 @@ script:
  - python -m pytest --cov
  - codecov
  - docker run --volume=$(pwd):/app --workdir=/app coala/base coala-ci
+  - python3 setup.py install
+  - bash ./.ci/deploy.sh


This should be done on deploy phase so failing builds doesn't get deployed.

jayvdb · 2017-12-03T14:58:30Z

.ci/deploy.sh

+ssh-add ../deploy_key
+
+# Now that we're all set up, we can push.
+git push $SSH_REPO $TARGET_BRANCH


No EOL at EOF (copying ... :P)

yukiisbored · 2017-12-03T14:59:07Z

Marking this as blocked since the builds are failing.

jayvdb · 2017-12-03T15:00:01Z

data/Constants.json

@@ -0,0 +1,7 @@
+{
+	"data":"data",


please add JSONBear to .coafile

jayvdb · 2017-12-03T15:00:22Z

data/roothome

@@ -0,0 +1 @@
+/home/tushar/coala


jayvdb · 2017-12-03T15:01:09Z

.travis.yml

@@ -1,12 +1,19 @@
 sudo: required
 dist: trusty

+env:
+  global:
+  - ENCRYPTION_LABEL: "79272d66a36b"


Yaml lint bear pls

jayvdb · 2017-12-03T15:01:30Z

.travis.yml

@@ -32,6 +39,8 @@ script:
  - python -m pytest --cov
  - codecov
  - docker run --volume=$(pwd):/app --workdir=/app coala/base coala-ci
+  - python3 setup.py install
+  - bash ./.ci/deploy.sh


this should be in deploy:

That’s a workaround for now, I’ll do that once tests start passing(as noted in PR description).

jayvdb

A few things to fix

nalinbhardwaj · 2017-12-03T17:10:32Z

For future readers, some discussion regarding the decisions can be found in Zulip.

yukiisbored · 2017-12-04T05:12:48Z

.travis.yml

 language: python
 node_js:
-  - "4.1"
+    - "4.1"


Hey this is not needed, it just makes some noise on the diff.

Ooh, I just ran YAMLLintBear and applied patch to it without checking anything. Will fix everything.

yukiisbored · 2017-12-04T05:12:54Z

.travis.yml

 python:
-  - "3.4"
+    - "3.4"


Hey this is not needed, it just makes some noise on the diff.

yukiisbored · 2017-12-04T05:13:01Z

.travis.yml

-  directories:
-    - node_modules
-    - coalahtml/_coalahtml/bower_components
+    pip: true


Hey this is not needed, it just makes some noise on the diff.

yukiisbored · 2017-12-04T05:13:13Z

.travis.yml

-  - pip install colorama==0.3.7
-  - pip install -r requirements.txt
-  - pip install -r test-requirements.txt
+    - npm install - g bower


Hey this is not needed, it just makes some noise on the diff.
This breaks CI as well due to that space between - and g

yukiisbored · 2017-12-04T05:14:02Z

.travis.yml

+    - cd -
+    # colorama needs to be upgraded to fix error when installed colorama
+    # version and required are different.
+    - pip install colorama == 0.3.7


Breaks CI, due to that space between packaage and version

yukiisbored · 2017-12-04T05:14:17Z

.travis.yml

+    # colorama needs to be upgraded to fix error when installed colorama
+    # version and required are different.
+    - pip install colorama == 0.3.7
+    - pip install - r requirements.txt


Break CI due to that space between the flag and the indicator

yukiisbored · 2017-12-04T05:14:25Z

.travis.yml

+    # version and required are different.
+    - pip install colorama == 0.3.7
+    - pip install - r requirements.txt
+    - pip install - r test-requirements.txt


Break CI due to that space between the flag and the indicator

yukiisbored · 2017-12-04T05:14:34Z

.travis.yml


 notifications:
-  email: false
+    email: false


Noise, not needed

yukiisbored · 2017-12-04T05:14:41Z

.travis.yml

-  - python -m pytest --cov
-  - codecov
-  - docker run --volume=$(pwd):/app --workdir=/app coala/base coala-ci
+    - npm test


Not needed.

yukiisbored · 2017-12-04T09:53:51Z

Sadly we can't merge it, master is broken :(

blazeu

BTW, is .rultor.yml modified because you run YAMLLintBear ?

blazeu · 2017-12-04T13:38:32Z

.ci/deploy.sh

+    exit 0
+fi
+
+# Commits to other branches should deploy to their respective gh-pages/<name>


Should be gh-pages-branch/<name> ?

blazeu · 2017-12-04T13:40:46Z

.travis.yml

@@ -31,7 +36,11 @@ script:
  - npm test
  - python -m pytest --cov
  - codecov
-  - docker run --volume=$(pwd):/app --workdir=/app coala/base coala-ci
+  - docker run --volume =$(pwd): / app --workdir = /app coala/base coala-ci


I think you shouldn't change this?
See https://travis-ci.org/coala/coala-html/builds/311194465#L686

@nalinbhardwaj

Just noticed the command is parsed like YAML

yukiisbored · 2017-12-04T15:24:47Z

.rultor.yml

-  fast-forward: only
-  script:
-    - bash .ci/check_maintainership.sh
+    fast-forward: only


Please undo this.

yukiisbored · 2017-12-04T15:24:56Z

.rultor.yml


 decrypt:
-  rultor_github_secrets.sh: "repo/.ci/rultor_github_secrets.sh.asc"
+    rultor_github_secrets.sh: "repo/.ci/rultor_github_secrets.sh.asc"


This as well.

Automates Github Pages deployment by making travis commit any changes to master to gh-pages branch, and other branch changes to gh-pages-branch/<original branch name>. Closes #133

yukiisbored · 2017-12-05T11:05:11Z

ack 70dfa00

nalinbhardwaj · 2017-12-05T12:46:02Z

Umm, @yukiisbored I think you forgot about the TODO from my PR description? That encrypted deploy key won’t work for this repo?

gitmate-bot added process/pending review size/XXL difficulty/medium initiatives/gci labels Dec 3, 2017

yukiisbored previously requested changes Dec 3, 2017

View reviewed changes

yukiisbored mentioned this pull request Dec 3, 2017

Generate JSON output on each deployment. #144

Open

yukiisbored mentioned this pull request Dec 3, 2017

Use Travis CI GitHub pages deployment feature. coala/community#15

Closed

yukiisbored requested changes Dec 3, 2017

View reviewed changes

jayvdb reviewed Dec 3, 2017

View reviewed changes

yukiisbored added the status/blocked label Dec 3, 2017

jayvdb reviewed Dec 3, 2017

View reviewed changes

data/Constants.json Outdated

@@ -0,0 +1,7 @@

{

"data":"data",

Copy link

Member

jayvdb Dec 3, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please add JSONBear to .coafile

jayvdb reviewed Dec 3, 2017

View reviewed changes

data/roothome

@@ -0,0 +1 @@

/home/tushar/coala

Copy link

Member

jayvdb Dec 3, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

EOL at EOF

jayvdb reviewed Dec 3, 2017

View reviewed changes

jayvdb requested changes Dec 3, 2017

View reviewed changes

jayvdb added process/wip and removed process/pending review labels Dec 3, 2017

gitmate-bot added the process/pending review label Dec 3, 2017

yukiisbored requested changes Dec 4, 2017

View reviewed changes

yukiisbored approved these changes Dec 4, 2017

View reviewed changes

blazeu requested changes Dec 4, 2017

View reviewed changes

yukiisbored requested changes Dec 4, 2017

View reviewed changes

CI: Automate Github Pages deployment

70dfa00

Automates Github Pages deployment by making travis commit any changes to master to gh-pages branch, and other branch changes to gh-pages-branch/<original branch name>. Closes #133

gitmate-bot added status/STALE and removed status/STALE labels Dec 5, 2017

yukiisbored approved these changes Dec 5, 2017

View reviewed changes

gitmate-bot added process/approved and removed process/pending review process/approved labels Dec 5, 2017

yukiisbored merged commit 70dfa00 into coala:master Dec 5, 2017

gitmate-bot added the process/approved label Dec 5, 2017

gitmate-bot added the status/STALE label Dec 20, 2017

CI: Add automatic Github Pages deployment #143

CI: Add automatic Github Pages deployment #143

Conversation

nalinbhardwaj commented Dec 3, 2017 • edited Loading

Checklist

yukiisbored left a comment

Choose a reason for hiding this comment

yukiisbored commented Dec 3, 2017

nalinbhardwaj commented Dec 3, 2017 • edited Loading

yukiisbored commented Dec 3, 2017 • edited Loading

nalinbhardwaj commented Dec 3, 2017

yukiisbored commented Dec 3, 2017

yukiisbored commented Dec 3, 2017

yukiisbored commented Dec 3, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yukiisbored commented Dec 3, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jayvdb left a comment

Choose a reason for hiding this comment

nalinbhardwaj commented Dec 3, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yukiisbored commented Dec 4, 2017

blazeu left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yukiisbored commented Dec 5, 2017

nalinbhardwaj commented Dec 5, 2017

nalinbhardwaj commented Dec 3, 2017 •

edited

Loading

nalinbhardwaj commented Dec 3, 2017 •

edited

Loading

yukiisbored commented Dec 3, 2017 •

edited

Loading

blazeu left a comment •

edited

Loading