From 77b9d0118ad90ca3193b2aac02be1d54cd7062cf Mon Sep 17 00:00:00 2001 From: Jennifer Power Date: Wed, 11 Oct 2023 16:52:26 -0400 Subject: [PATCH] docs: adds PR feedback and moves "add action" steps to actions README.md Signed-off-by: Jennifer Power --- CONTRIBUTING.md | 6 +----- actions/README.md | 7 ++----- 2 files changed, 3 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8503407b..d1debe40 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. \ No newline at end of file +``` \ No newline at end of file diff --git a/actions/README.md b/actions/README.md index cf9ed856..026d8107 100644 --- a/actions/README.md +++ b/actions/README.md @@ -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.