Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
leneffets committed Nov 15, 2024
1 parent 95af63b commit 5245797
Showing 1 changed file with 2 additions and 49 deletions.
51 changes: 2 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# SSM and S3 Server

This project provides an HTTP server using Go, which interacts with AWS Systems Manager (SSM) to fetch parameters and with S3 to fetch files. The server exposes two main endpoints: `/ssm` and `/s3`.
This project provides an HTTP server using Go, which interacts with AWS Systems Manager (SSM) to fetch parameters and with S3 to fetch files. This project is useful for running a sidecar, to use original images without a hassle.
The server exposes two main endpoints: `/ssm` and `/s3`.

## Features

Expand Down Expand Up @@ -86,54 +87,6 @@ This project uses GitHub Actions for continuous integration. The pipeline is def
- Builds the project.
- Runs tests.

### Setting Up the GitHub Actions Pipeline

1. **Ensure the workflow file exists:**

The workflow file `.github/workflows/ci.yml` should be present in your repository. If not, create it and paste the following content:

```yaml
name: Go CI
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Set up Go
uses: actions/setup-go@v2
with:
go-version: 1.17
- name: Install dependencies
run: go mod tidy
- name: Build
run: go build -v ./...
- name: Run tests
run: go test -v ./...
```

2. **Push changes to the repository:**

Commit and push your changes to trigger the pipeline:

```sh
git add .
git commit -m "Add CI pipeline for build and test"
git push origin main
```

3. **Review pipeline runs:**

Go to the `Actions` tab in your GitHub repository to view the status of the workflow runs.
Expand Down

0 comments on commit 5245797

Please sign in to comment.