Skip to content

Commit

Permalink
Remove last references to Github Actions
Browse files Browse the repository at this point in the history
[skip ci]
  • Loading branch information
ivotron committed Jun 3, 2020
1 parent 226b785 commit 0d84855
Show file tree
Hide file tree
Showing 5 changed files with 84 additions and 259 deletions.
61 changes: 13 additions & 48 deletions docs/sections/cli_features.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,21 +106,23 @@ following workflow:
args: [env]
```

To define new variables, the `env` keyword can be used (see [
Attributes][act-attr] for more).
To define new variables, the `env` keyword can be used (see [Step
Attributes section][act-attr] for more).

[act-attr]: gha_workflows.html#action-attributes
[act-attr]: cn_workflows.html#workflow-step

## Reusing existing container images

**TODO**

## Reusing existing workflows

Many times, when starting an experiment, it is useful to be able to use
an existing workflow as a scaffold for the one we wish to write. The
[`popper-examples`
repository](https://github.com/popperized/popper-examples) contains a
list of example workflows and actions for the purpose of both learning
and to use them as a starting point. Another examples can be found on
Github's [official `actions`
organization](https://github.com/actions).
list of example workflows for the purpose of both learning and to use
them as a starting point.

Once you have found a workflow you're interested in importing, you can
use the `popper add` command to obtain a workflow. For example:
Expand All @@ -136,47 +138,6 @@ Workflow docker-data-science has been added successfully.
This will download the contents of the workflow and all its
dependencies to your project tree.


## Searching for actions

The popper CLI is capable of searching for premade actions that
you can use in your workflows.

You can use the `popper search` command to search for actions
based on a search keyword. For example, to search for npm based actions,
you can simply run:

```bash
$ popper search npm
Matched actions :

> popperized/npm
```

Additionally, when searching for an action, you may choose to include
the contents of the readme in your search by using the `--include-readme`
flag.

Once `popper search` runs, it caches all the metadata related to the
search. So, to get the latest releases of the actions, you might want
to update the cache using the `--update-cache` flag.

By default, popper searches for actions from a list present
[here](https://github.com/systemslab/popper/blob/master/cli/resources/search_sources.yml).
To help the list keep growing, you can add Github organization names
or repository names(org/repo) and send a pull request to the upstream
repository.


To get the details of a searched action, use the `popper info`
command. For example:

```bash
popper info popperized/cmake
An action for building CMake projects.
```


## Continuously validating a workflow

The `ci` subcommand generates configuration files for multiple CI
Expand Down Expand Up @@ -319,3 +280,7 @@ The above generates a `wf.png` file depicting the workflow.
Alternatively you can use the <http://www.webgraphviz.com/> website to
generate a graph by copy-pasting the output of the `popper dot`
command.

## Executing a step interactively

**TODO**
5 changes: 3 additions & 2 deletions docs/sections/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,6 @@ examples.

### How to apply the Popper protocol for applications that take large quantities of computer time?

The `popper run` takes an optional `action` argument that can be used
to execute a workflow up to a certain step. Run `popper run --help` for more.
The `popper run` takes an optional `STEP` argument that can be used to
execute a workflow up to a certain step. Run `popper run --help` for
more.
7 changes: 3 additions & 4 deletions docs/sections/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ container is instantiated. For a more detailed description of how
Popper processes a workflow, take a look at the ["Workflow Language
and Runtime"](cn_workflows.md) section. To learn more on how to modify
this workflow in order to fit your needs, take a look at [this
tutorial][ghatut] or take a look at [some examples][ex].
tutorial][poppertut] or take a look at [some examples][ex].

Before we go ahead and test this workflow, we first commit the files
to the Git repository:
Expand Down Expand Up @@ -226,14 +226,13 @@ Go to the TravisCI website to see your experiments being executed.
For a detailed description of how Popper processes workflows, take a
look at the ["Workflow Language and Runtime"](cn_workflows.md)
section. To learn more on how to modify workflows to fit your needs,
take a look at [this tutorial][ghatut] or at [some examples][ex].
take a look at [this tutorial][poppertut] or at [some examples][ex].

[docker-install]: https://docs.docker.com/install/
[wfeng]: https://en.wikipedia.org/wiki/Workflow_engine
[cn]: https://cloudblogs.microsoft.com/opensource/2018/04/23/5-reasons-you-should-be-doing-container-native-development/
[pip]: https://pip.pypa.io/en/stable/
[wfdocs]: gha_workflows.md
[ghatut]: https://popperized.github.io/swc-lesson/
[poppertut]: https://popperized.github.io/swc-lesson/
[ex]: https://github.com/popperized/popper-examples
[gh-create]: https://help.github.com/articles/create-a-repo/
[cisetup]: https://docs.travis-ci.com/user/getting-started/#Prerequisites
Expand Down

0 comments on commit 0d84855

Please sign in to comment.