circleci / circleci-docs Goto Github PK

RE: jekyll/_docs/build-artifacts.md

https://circleci.com/docs/build-artifacts/ doesn't mention any limits on the sizes of build artifacts (I see #122 mentions a 3GB size limit on individual artifacts; what about total size per build, or per project?), nor how long Circle promises to host the artifacts (e.g. only 3 months like (random example) Ghost Inspector, or indefinitely but promise 6 months warning if you're gonna start taking them down, etc).

For my case I'm not actually worried about the size limit (though I would love to see it documented), just retention, especially since the filepaths are all .../tmp/circle-artifacts.AvvFajf/..., which isn't exactly resounding with permanence. Can I hotlink them, or should I be uploading them somewhere else? (Imgur probably)

There may be other limits worth documenting, too. (Rate limits on downloads? That's probably high enough not to be worth documenting.)

You've got a markdown issue on this page.

Actually this is about ALL the docs pages. The search bar doesn't do a damn thing in safari or chrome. Return doesn't seem to post. There is no JS running dynamically afaict. Just... a box with words I typed.

In the text:
"Go to https://github.com/you/test-repo/settings/keys on GitHub and add the public key that you just created. Make sure to check on Allow write access and save the key. You can enter any title in the Title field."

"Make sure to check on Allow write access and save the key" is confusing, there is no place to "Allow write access and save the key"

I found through trial and error that our deployment section supports (?i) as a regex mode modifier for case insensitivity, since a customer was trying to write a case-insensitive regex. Because there are so many regex flavors out there, would it make sense to have a regex section in our docs? Or better yet, can we link to docs for a reference implementation that we're using?

This jekyll issue suggests you can get this for free with some Markdown processors, like Redcarpet.

The xdebug section says sed -i 's/^;//' /opt/circleci/php/$(phpenv global)/etc/conf.d/xdebug.ini enables xdebug. This does not work (tried with php 7.0.4 and php 5.5.9). Changing it to sed -i 's/^;//' ~/.phpenv/versions/$(phpenv global)/etc/conf.d/xdebug.ini worked.

Would be great to have a web-based testbed for using the API

Undo PR #94 once the containers have Android SDK 24.1.1 pre installed.

I used background: true to start the web server for testing. But it is error saying 'mapping values are not allowed here'

test:
post:
- npm run server
background: true
- npm run e2e

Tox is a fairly standard test runner for Python. Having some comments on best practices for running tox tests under circle would be a useful addition to this document.

At the top of the services section, we have:

CircleCI supports a large number of databases and other services. Most popular ones are running by default on our build machines (bound to localhost), including Postgres, MySQL, Redis and MongoDB.

This is true on the Precise container, but not on the Trusty container. I believe we defaulted most services to not running to save ram for Android builds.

Is it better to move this snippet into the Precise doc? Should there be a page for "changes to be aware of switching from Precise to Trusty"?

The documentation specifies that the php conf.d is located at ~/.phpenv/versions/$(phpenv global)/etc/conf.d

In circle.yaml, I had to use /opt/circleci/php/$(phpenv global)/etc/conf.d because the documented path threw bash: line 1: ~/.phpenv/versions/$(phpenv global)/etc/conf.d/timezone.ini: No such file or directory

RE: jekyll/_docs/how-cache-works.md

Right now only things in the home folder (owned by the ubuntu user) may be cached. To reduce confusion we should make this explicit in the doc.

If someone needs to cache something that is not owned by the ubuntu user they can either:

1. install the dependencies into the home folder rather than the standard location
2. Change the ownership of the directory outside of home to be owned by the ubuntu user

Your document makes it clear that you can't pragmatically export environment variables using EXPORT or similar.

What it doesn't tell you though is alternative strategies where you need to do this.

For instance I build a docker image, and then get the tag ID using docker images -q repo/build:tag

I then use that tag ID to create two more tags. Or at least I would, but I can't set a dynamic variable using the command above.

So right now I'm thinking of echoing it to a file on disk, and then catting that file back when I need it. A little messy and non-obvious.

Do you have a better solution than this? Could it be documented here?

All documentation references this page as where we can find a list of supported PHP versions. However, this page does not contain that information.

https://discuss.circleci.com/t/use-api-to-initiate-watching-a-project/933/3?u=drazisil

'https://circleci.com/api/v1/project/:user/:repo/follow?circle-token=:token' appears to be missing from the API docs. Is this still valid?

Brought up by Kunal.

In https://circleci.com/docs/google-cloud-platform/ and https://circleci.com/docs/google-auth/ there are a couple of places where the example suggested running
gcloud components update

this won't succeed without sudo.

ERROR: (gcloud.components.update) You cannot perform this action because you do not have permission to modify the Google Cloud SDK installation directory [/opt/google-cloud-sdk].

Re-run the command with sudo: sudo /opt/google-cloud-sdk/bin/gcloud ...

gcloud --quiet components update kubectl returned exit code 1

Action failed: gcloud --quiet components update kubectl

the correct example should be:
sudo /opt/google-cloud-sdk/bin/gcloud --quiet components update

This page says "You can find more details about supported versions here." and directs me to the node.js specific page. The node page should describe what versions are available to install.

https://github.com/circleci/frontend/tree/master/resources/assets/docs

The instructions for attaching no longer work.

This did
https://jpetazzo.github.io/2014/03/23/lxc-attach-nsinit-nsenter-docker-0-9/

but it seems like overkill.

Perhaps we can clarify where the "rebuild without cache" button is any maybe screenshot it.

https://discuss.circleci.com/t/where-is-the-rebuild-without-cache-button/3775

I love this shit

Currently there are three environment documentation pages:

• The landing page
• Ubuntu 12.04 page
• Ubuntu 14.04 page

However, only the Ubuntu 12.04 lists the environment variables available during a build inside the container. So, its unclear to me whether the environment variables are the same regardless of environment, or if there are differences in which environment variables exposed. (Let's ignore build parameters from the build API, since I'm only discussing CircleCI provided environment variables.)

Here's my proposal:

• If the environments are the same in Ubuntu 12.04 and 14.04, then move the environment variables to the landing page and off the ubuntu 12.04 page
• If there are differences between the two build environments, list all of the CircleCI provided environment variables on each page.

Some docs, like ones used as redirects, should not come up in search. Probably not in the sitemap either.

@eric-hu and I confirmed that since curl does not support streaming uploads there is a system limitation of roughly 3GB for the max size of a single artifact.

RE: jekyll/_docs/build-image-trusty.md

I'm assuming they're supposed to expand?

Example:

The sample circle.yml doesn't lint: http://www.yamllint.com/

Error: "mapping values are not allowed in this context at line 31 column 15"

If you remove the following line, the sample lints:

branch: master

Many install locations for languages have changed in the Ubuntu 14.04 image. We need to update relavant docs.

This document describes what the deploy.sh script does, but doesn't actually display it, nor does it have a direct link to it on an external page. There is a link at the very top of the article to the sample project (https://github.com/circleci/go-ecs-ecr) that contains this script, but I think it'd be easier to follow the document if it included the relevant code inline with the explanations, or there was a direct link to the file you could bring up in another tab without having to dig through links to find the code.

Example: https://circleci.com/docs/build-image-precise/#android-sdk

Loads with "Android SDK" not visible, since it's under the navigation header.

What's difference between 3 stages of dependencies( pre, override, post). And what is the thing being overridden?
And What's difference between 3 stages of test( pre, override, post). And what is the thing being overridden?
And What's difference between 2 stages of machine( pre, post).

We write:

By default, when testing in parallel, CircleCI runs all tests in the test/unit, test/integration, and test/functional directories. You can add minitest_globs to replace the standard directories with your own. This is needed only when you have additional or non-standard test directories and you are testing in parallel with MiniTest.

However, it is important to note that running parallel will only run tests in those directories. If you do not specify other directories than it will appear that we are skipping tests during the build.

The documentation (https://circleci.com/docs/android/) suggests that the Android NDK is available, but it does not appear to be (at least in Ubuntu 14.04).

PyOpenSSL is missing for using the gcloud command, otherwise you wil get the error like in this build

Also after I installed the PyOpenSSL via "sudo apt-get install python-openssl" I started seeing the following error in this build even the CLOUDSDK_PYTHON_SITEPACKAGES environment variable is set to 1 in the circle.yml.
Couldn't figure out why that didn't work, but as a workaround, I ended up removing the preinstalled gcloud and re-installing a new one like discussed in this forum thread.

https://discuss.circleci.com/t/deployment-to-appengine-fails-pyopenssl-not-available/2154

Why not a "migrating from Travis" page ?

dependencies:
  pre:
    - echo "memory_limit = 64M" > ~/.phpenv/versions/$(phpenv global)/etc/conf.d/memory.ini

This way of adding custom configuration to PHP just doesn't work. No such directories in user's home and from everything it looks like it's not the correct way to add .ini configurations anymore.

Please advice/fix.

Tnx

The docs here don't say which versions of Java are installed, or how to refer to them in the circle.yml doc.

Missing MySQL version number

Version: ``

Pages now 404ing that we need to redirect:

• https://circleci.com/docs/environment/
• https://circleci.com/docs/trusty-image/

Pages with links without trailing slashes:

• jekyll/_docs/configuration.md
• jekyll/_docs/manually.md
• jekyll/_docs/time-seconds.md

Pages with links containing double trailing slashes:

• jekyll/_docs/language-ruby-on-rails.md

I am trying to run test on a node project, but the tests aren't running because it says:

"We did not test this push because the project has been suspended. Please contact us if you think this is a mistake."

I've tried on repo's that are in my personal account and an organizational account. Any documentation on what is meant by "suspended"?

Formatting/Markdown appears off on this doc.

Should use the same GCP credentials envar as https://circleci.com/docs/google-auth/

This page refers to it as $ACCT_AUTH and the other page refers to it as $CLIENT_SECRET

On this page we say We use``as our default version. but do not list the actual version.

https://circleci.com/docs/language-nodejs/

If I add --format json --out $CIRCLE_TEST_REPORTS/cucumber/tests.cucumber as per the suggestion in this document, I get no output from the build myself. Is there a way to collect these artifacts while still seeing the build progress?

Noticed when taking a look at #136