Skip to content

Commit

Permalink
docs: adds PR feedback and moves "add action" steps to actions README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Jennifer Power <[email protected]>
  • Loading branch information
jpower432 committed Oct 12, 2023
1 parent e9eba9b commit 77b9d01
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 10 deletions.
6 changes: 1 addition & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,4 @@ cat my-token.txt | podman secret create repo-secret -

```bash
podman run --entrypoint /entrypoint.sh --secret repo-secret,type=env,target=GITHUB_TOKEN --env-file=envfile -v my-trestle-space:/data -w /data localhost:5000/trestlebot:latest
```

### Adding a new action

First, create an entrypoint script for the new action in the `trestlebot/entrypoints` directory. Then add the action by creating a new directory in the `actions` directory with an `action.yml` that references your new entrypoint.
```
7 changes: 2 additions & 5 deletions actions/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
# Actions


Tasks in trestle-bot that we want to expose as an Action are located here.
Tasks in trestle-bot that we want to expose as a GitHub Action are located here.

# Adding a new Action

> Note to contributors: We are trying to limit the task that we expose as actions to workspace manage operations and checks only.
1. Add a new folder with the action name
2. Add an action.yml
3. Add an entrypoint script to handle inputs from GitHub Actions
4. Add a COPY line in the Dockerfile
First, create an entrypoint script for the new action in the `trestlebot/entrypoints` directory. Then add the action by creating a new directory in the `actions` directory with an `action.yml` that references your new entrypoint. See the [GitHub Actions documentation](https://docs.github.com/en/actions/creating-actions/creating-a-docker-container-action) for more information.

0 comments on commit 77b9d01

Please sign in to comment.