From e7ae9d7104e57dd7442d47d97e8d83263fbcdb0d Mon Sep 17 00:00:00 2001 From: Andy Malakov Date: Fri, 20 Jun 2025 09:48:25 -0400 Subject: [PATCH] cleaned README of CI/CD instructions --- README.md | 39 ++++----------------------------------- ci-cd.md | 27 +++++++++++++++++++++++++++ 2 files changed, 31 insertions(+), 35 deletions(-) create mode 100644 ci-cd.md diff --git a/README.md b/README.md index 85a3a1f..2521ffa 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,7 @@ -# java-profiler-tools +# FlameGraph + Async Profiler as Docker Image -FlameGraph + Async Profiler as docker image +This is a Docker image containing [Brendan Gregg's FlameGraph](https://github.com/brendangregg/FlameGraph) and [Andrei Pangin's Async Profiler](https://github.com/async-profiler/async-profiler). -This is docker image containing [Brendan Gregg's Flame Graph](https://github.com/brendangregg/FlameGraph) as well as [Andrei Pangin's Async Profiler](https://github.com/async-profiler/async-profiler). - -This container can be handy when you need to attach to some Java container and perform on the spot profiling. - -Usage example can be found [here](https://ember.deltixlab.com/docs/kb/profiling/?_highlight=perf#profiling-ember-with-perf). - -## CI/CD - -This project uses GitHub Actions for continuous integration and deployment: - -### Build Workflow -- **File**: `.github/workflows/docker-build.yml` -- **Triggers**: Push to main/master branch, pull requests, manual dispatch -- **Actions**: Builds the Docker image and runs basic tests -- **No external dependencies required** - -### Publish Workflow (Optional) -- **File**: `.github/workflows/docker-publish.yml` -- **Triggers**: Push tags starting with 'v' (e.g., v1.0.0), manual dispatch -- **Actions**: Builds and publishes the Docker image to Docker Hub -- **Required secrets**: `DOCKER_USERNAME` and `DOCKER_PASSWORD` - -### Setting up Docker Hub Publishing -If you want to publish to Docker Hub, add these secrets to your GitHub repository: -1. Go to your repository Settings → Secrets and variables → Actions -2. Add `DOCKER_USERNAME` with your Docker Hub username -3. Add `DOCKER_PASSWORD` with your Docker Hub access token - -Then create a tag to trigger the publish workflow: -```bash -git tag v1.0.0 -git push origin v1.0.0 -``` +The container is especially useful for profiling Java applications in remote or production environments where installing additional tools is undesirable or restricted. In such cases, the container can be launched on demand, attached to a running Java process, and removed afterward without leaving a footprint. +Usage example can be found in [this article](https://ember.deltixlab.com/docs/kb/profiling/?_highlight=perf#profiling-ember-with-perf). diff --git a/ci-cd.md b/ci-cd.md new file mode 100644 index 0000000..afb232e --- /dev/null +++ b/ci-cd.md @@ -0,0 +1,27 @@ +## CI/CD + +This project uses GitHub Actions for continuous integration and deployment: + +### Build Workflow +- **File**: `.github/workflows/docker-build.yml` +- **Triggers**: Push to main/master branch, pull requests, manual dispatch +- **Actions**: Builds the Docker image and runs basic tests +- **No external dependencies required** + +### Publish Workflow (Optional) +- **File**: `.github/workflows/docker-publish.yml` +- **Triggers**: Push tags starting with 'v' (e.g., v1.0.0), manual dispatch +- **Actions**: Builds and publishes the Docker image to Docker Hub +- **Required secrets**: `DOCKER_USERNAME` and `DOCKER_PASSWORD` + +### Setting up Docker Hub Publishing +If you want to publish to Docker Hub, add these secrets to your GitHub repository: +1. Go to your repository Settings → Secrets and variables → Actions +2. Add `DOCKER_USERNAME` with your Docker Hub username +3. Add `DOCKER_PASSWORD` with your Docker Hub access token + +Then create a tag to trigger the publish workflow: +```bash +git tag v1.0.0 +git push origin v1.0.0 +``` \ No newline at end of file