Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update build lifecycle docs #333

Merged
merged 2 commits into from Sep 13, 2013
Merged

Update build lifecycle docs #333

merged 2 commits into from Sep 13, 2013

Conversation

troyswanson
Copy link
Contributor

Updates the documentation to reflect the current lifecycle for builds. Also tries to offer examples for what types of commands to run during the various hooks. This is my best guess based on my interpretation of the code, but I'm open to being wrong about any of this. Here's the new copy:

  1. Clone project repository from GitHub
  2. cd to clone directory
  3. Checkout commit for this build
  4. Run before_install commands
    • Use this to prepare the system to install prerequisites or dependencies
    • e.g. sudo apt-get update
  5. Run install commands
    • Use this to install any prerequisites or dependencies necessary to run your build
  6. Run before_script commands
    • Use this to prepare your build for testing
    • e.g. copy database configurations, environment variables, etc.
  7. Run test script commands
    • Default is specific to project language
    • All commands must exit with code 0 on success. Anything else is considered failure.
  8. Run after_success or after_failure commands
  9. Run after_script commands

And here's a screenshot of what it looks like:
screen shot 2013-09-02 at 3 53 04 pm

Feel free to let me know what you think!

Ref #239

Decided on an ordered list, since it is certainly an ordered operation.
Also am now using nested unordered lists to give additional details.
Modified some css to make it look nice.
@roidrage
Copy link
Contributor

roidrage commented Sep 3, 2013

❤️

Thank you!

@nschonni
Copy link
Contributor

nschonni commented Sep 8, 2013

I like it! Would it look OK without those list CSS overrides?

@joshk
Copy link
Contributor

joshk commented Sep 8, 2013

This looks good to me, @roidrage your thoughts?

@troyswanson
Copy link
Contributor Author

@nschonni Not really. I'll comment on the diff...

margin: 1em 0;
}
#main ol li ul li {
list-style-type: circle;

This comment was marked as spam.

@troyswanson
Copy link
Contributor Author

Anyone have any more thoughts on this? I would love for it to be merged. 😄

roidrage added a commit that referenced this pull request Sep 13, 2013
@roidrage roidrage merged commit 46b70e3 into travis-ci:master Sep 13, 2013
@roidrage
Copy link
Contributor

@troyswanson thanks so much for the updated docs!

@troyswanson
Copy link
Contributor Author

Any time! 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants