Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
danphilibin committed Sep 13, 2024
1 parent 26297f5 commit 9fd1072
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
# Campsite GitHub Action

This GitHub Action allows you to create posts, comments, or messages on Campsite directly from your GitHub workflow. It's perfect for automating updates, sharing build statuses, or notifying your team about important events in your deployment workflows.
This GitHub Action allows you to create posts, comments, or messages on [Campsite](https://campsite.com) directly from your GitHub workflow. It's perfect for automating updates, sharing build statuses, or notifying your team about important events in your deployment workflows.

## Usage

To use this action in your workflow, you need to set up the necessary inputs. Here are some examples:
You will need an API key to use this action. Follow these steps to create an API key in Campsite:

1. Go to your Organization settings and click the **Integrations** tab.
2. In the **API keys** box, click the **+ New** button and enter a name for your integration.
3. After you create the app, copy the API key that appears.
4. Create a [GitHub secret](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository) with the value as the API key you just created. We use `CAMPSITE_API_KEY` in the examples below, but you can use any name you want.

### Create a post

```yml
- name: Create Campsite Post
uses: campsite/campsite-github-action@v1
uses: campsite/campsite-github-action@v0.1.0
with:
api_key: ${{ secrets.CAMPSITE_API_KEY }}
action_type: create_post
Expand All @@ -23,7 +28,7 @@ To use this action in your workflow, you need to set up the necessary inputs. He
```yml
- name: Add Deployment Status Comment
uses: campsite/campsite-github-action@v1
uses: campsite/campsite-github-action@v0.1.0
with:
api_key: ${{ secrets.CAMPSITE_API_KEY }}
action_type: "create_comment"
Expand All @@ -43,7 +48,7 @@ To use this action in your workflow, you need to set up the necessary inputs. He
```yml
- name: Send Campsite Message
uses: campsite/campsite-github-action@v1
uses: campsite/campsite-github-action@v0.1.0
with:
api_key: ${{ secrets.CAMPSITE_API_KEY }}
action_type: create_message
Expand Down Expand Up @@ -88,7 +93,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Create Campsite Post
uses: campsite/campsite-github-action@v1
uses: campsite/campsite-github-action@v0.1.0
with:
api_key: ${{ secrets.CAMPSITE_API_KEY }}
action_type: "create_post"
Expand Down

0 comments on commit 9fd1072

Please sign in to comment.