Start using .travis.yml as a configure doctr. by Carreau · Pull Request #137 · drdoctr/doctr

Carreau · 2016-11-09T01:48:49Z

My guess is it will be easier with a subparser.

Just playing with it for now, see what's needed.

asmeurer · 2016-11-09T02:33:38Z

+def get_config():
+    """
+    This load some configuration from the `travis.yml`, file is present,
+    `doctr` key if present.


Two backquotes for RST.

asmeurer · 2016-11-09T02:34:14Z


+def get_config():
+    """
+    This load some configuration from the `travis.yml`, file is present,


.travis.yml

Carreau · 2017-03-07T01:30:06Z

Reviving this as part of the docathon.

I've cleaned it up a bit and will appreciate review.

Carreau · 2017-03-07T01:30:47Z

Oh, of course test are failing as the PR is from a branch not on this repo.

asmeurer · 2017-03-07T20:06:14Z

-      python -m doctr deploy --no-require-master --gh-pages-docs "docs-$TRAVIS_BRANCH" --built-docs docs/_build/html --key-path deploy_key.enc;
-      python -m doctr deploy --no-require-master --key-path deploy_key.enc --no-sync --command "echo test";
+      if [[ -z "${DOCTR_DEPLOY_ENCRYPTION_KEY}" ]]; then
+          echo "DOCTR_DEPLOY_ENCRYPTION_KEY not set, likely building a PR from untrusted repository";


We ought to be testing this in doctr itself. Is this happening to you here?

Hum, yes on my fork. Let me see if it was not rebased on the lastest.

"We ought" meaning we should. I don't know if we actually are (but if we aren't, we need to be). Someone actually reported this same error on SymPy, so I think there may be a real bug here.

In any case, let's fix this in a separate PR.

We do it when we decrypt the key on Travis: https://github.com/drdoctr/doctr/blob/master/doctr/travis.py#L51

That's only supposed to be called with canpush is True.

doctr/doctr/travis.py

Line 185 in 84d09b1

setup_deploy_key(keypath=keypath, key_ext=key_ext)

. So either we have a bug or Travis does (maybe $TRAVIS_PULL_REQUEST is not always set properly).

It would be nice if we could keep this as an error, because it is a legitimate error if someone didn't set up their .travis.yml correctly. Maybe there is a more robust way to detect pull requests than looking at the environment variables.

Let's open an issue for this.

asmeurer · 2017-03-07T20:07:17Z

+- ``setup_GitHub_push`` now takes a ``branch_whitelist`` parameter instead of
+  of a ``require_master``
+- ``.travis.yml`` can be used to store some of doctr configuration in addition
+  to the command line flags. Write doctr configuration under the ``doctr`` key.


Add :issue:`137` to these.

asmeurer · 2017-03-07T20:08:17Z

+The configuration parameters available from the ``.travis.yml`` file often
+mirror their command line siblings except dashes ``-`` are replaced by
+underscores ``_``. Some parameters are not available from configuration files
+for security reasons.


Can we be more specific here? Are there any values that aren't the same after replacing - with _? Which flags aren't available for security reasons?

Can we be more specific here? Are there any values that aren't the same after replacing - with _? Which flags aren't available for security reasons?

Hum, I don't remember. I'm using safe_load from Yaml so itm might be due to that. I'll rephrase.

All the parameters are paths (strings). Unexpected stuff can happen in YAML if you don't quote a string and it looks like another literal (like a float), but that's unlikely to happen here. I can't think of any other issues.

Oh, yeah. --token, if you allow a token option, it means pasting the token in clear in the file.

--token is a boolean flag. The token can only be accessed from a encrypted environment variable.

asmeurer · 2017-03-07T20:08:52Z

+Use a ``doctr`` section in your ``travis.yml`` file to store your doctr
+configuration:
+
+.. code::


You can set this as YAML language (though IIRC the highlighting might not actually work).

asmeurer · 2017-03-07T20:09:27Z

+  - script: py.test
+  - doctr:
+    gh_pages_docs: 'documentation'
+    key_path : '/absolute/key/path.key'


Absolute key path? The key path should be relative to the github repo.

asmeurer · 2017-03-07T20:09:57Z

+  - language: python
+  - script: py.test
+  - doctr:
+    gh_pages_docs: 'documentation'


This will change with #157 (which will be merged soon).

asmeurer · 2017-03-07T20:11:44Z

+.. code::
+
+  - language: python
+  - script: py.test


You still have to actually call doctr deploy in the script though, right?

asmeurer · 2017-03-07T20:12:13Z

+
+    config = travis_config.get('doctr',{})
+
+    if type(config) == list:


if not isinstance(config, dict)?

asmeurer · 2017-03-07T20:12:44Z

+    This load some configuration from the ``.travis.yml``, if file is present,
+    ``doctr`` key if present.
+    """
+    with open('.travis.yml') as travis_config_file:


Add a check if the file exists.

asmeurer · 2017-03-07T20:13:36Z


        if args.command:
-            run(shlex.split(args.command))
+            run([os.path.expanduser(x) for x in shlex.split(args.command)])


Why is this change here? I don't think we should do this.

asmeurer · 2017-03-07T20:13:58Z

+
+    if type(config) == list:
+        raise ValueError('config is not a dict: {}'.format(config))
+    return travis_config.get('doctr',{})


return config?

Carreau · 2017-03-09T00:27:12Z

Ok, I'm tired today, I did a lot of mistakes, but that should be all fixed.

asmeurer · 2017-03-09T02:15:32Z

I pushed the branch up to this repo so the tests can run from that.

asmeurer · 2017-03-09T02:16:14Z

We should probably add some configuration to our .travis.yml to test this (the existing tests will still work as they are as the command line flags override the .travis.yml keys).

Carreau · 2017-03-09T06:34:54Z

We should probably add some configuration to our .travis.yml to test this (the existing tests will still work as they are as the command line flags override the .travis.yml keys).

Done, I had to add opposites of some command line flags like --sync/--no-sync to be able to overwrite config file.

asmeurer · 2017-03-09T06:48:49Z

Cool. By the way, it's easier to review your changes if you do them as new commits.

- Change require master to branch_whitelist

Carreau · 2017-03-14T02:22:46Z

Cool. By the way, it's easier to review your changes if you do them as new commits.

Conflict addressed and push as multiple commits.

asmeurer · 2017-03-14T02:53:08Z

Let's give it a try. Also self reminder we need to add pyyaml to the conda-forge recipe when we release.

asmeurer reviewed Nov 9, 2016

View reviewed changes

Carreau force-pushed the travis-config branch from 512d6a0 to f4d2864 Compare November 10, 2016 20:05

Carreau force-pushed the travis-config branch 8 times, most recently from 2cb985d to 0c097df Compare March 7, 2017 01:26

Carreau changed the title ~~[WIP] Start using .travis.yml as a configure doctr.~~ Start using .travis.yml as a configure doctr. Mar 7, 2017

asmeurer reviewed Mar 7, 2017

View reviewed changes

gforsyth mentioned this pull request Mar 7, 2017

Looking for deploy key when it shouldn't? #161

Open

Carreau force-pushed the travis-config branch 4 times, most recently from e2c1e31 to 5063e61 Compare March 8, 2017 23:58

Carreau force-pushed the travis-config branch 5 times, most recently from 154e218 to 08b31cc Compare March 9, 2017 00:20

Carreau mentioned this pull request Mar 9, 2017

add command line argument deploy_branch_name that specifies a target … #164

Closed

Carreau force-pushed the travis-config branch from 08b31cc to d0f8aa0 Compare March 9, 2017 06:31

gforsyth mentioned this pull request Mar 9, 2017

make deploy directory required argument #157

Merged

Carreau added 6 commits March 13, 2017 19:03

Use travis.yml as a config file

f091d47

- Change require master to branch_whitelist

'rename gh-pages-docs to deploy-directory'

84e29e9

'replace . with _ in deploy_parser_add_argument'

0a4bf02

Remove deploy-directory/gh-pages-docs from config

edea11a

Mutate config object to find unused options.

eb62a70

fix docs forgotten now mandatory deploy-directory

be9d769

Carreau force-pushed the travis-config branch from d0f8aa0 to be9d769 Compare March 14, 2017 02:17

Pretty print non-regcognized options in travis.yml.

f3e5697

asmeurer merged commit a63f788 into drdoctr:master Mar 14, 2017

Carreau deleted the travis-config branch March 14, 2017 17:12

gforsyth mentioned this pull request Mar 17, 2017

.travis.yml as a config file ? #136

Closed


		config = travis_config.get('doctr',{})

		if type(config) == list:

Uh oh!

Conversation

Carreau commented Nov 9, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Carreau commented Mar 7, 2017

Uh oh!

Carreau commented Mar 7, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Carreau commented Mar 9, 2017

Uh oh!

asmeurer commented Mar 9, 2017

Uh oh!

asmeurer commented Mar 9, 2017

Uh oh!

Carreau commented Mar 9, 2017

Uh oh!

asmeurer commented Mar 9, 2017

Uh oh!

Carreau commented Mar 14, 2017

Uh oh!

asmeurer commented Mar 14, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants