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

fix: add documentation for wrapping steps #95

Merged
merged 1 commit into from
Jul 10, 2017
Merged

fix: add documentation for wrapping steps #95

merged 1 commit into from
Jul 10, 2017

Conversation

d2lam
Copy link
Member

@d2lam d2lam commented Jul 10, 2017

Adding documentation for wrapping a step

Related: screwdriver-cd/screwdriver#616

- postinstall: echo post-install
```

This will run the command `echo pre-install` before the `install` step, and `echo post-install` after the `install` step.
Copy link
Member

Choose a reason for hiding this comment

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

maybe:
before the template's install step
and
after the template's install step

And/or should we include an example of the combined screwdriver yaml?

jobs:
    main:
        image: node:6
        steps:
            - preinstall: echo pre-install
            - install: npm install
            - postinstall: echo post-install
            - test: npm test
            - echo: echo $FOO
        environment:
            FOO: bar
        secrets:
            - NPM_TOKEN

Copy link
Member Author

Choose a reason for hiding this comment

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

I added template to make it more clear. I think the concept is simple enough that we wouldn't need to give a combined screwdriver yaml.

Copy link
Member

@tkyi tkyi left a comment

Choose a reason for hiding this comment

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

@d2lam d2lam merged commit 7a72142 into master Jul 10, 2017
@d2lam d2lam deleted the wrapdocs branch July 10, 2017 22:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants