Skip to content

Commit ecd9630

Browse files
committed
README.md: Improve readme
1 parent 19c6ba1 commit ecd9630

File tree

1 file changed

+8
-12
lines changed

1 file changed

+8
-12
lines changed

README.md

+8-12
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,20 @@
11
# GitHub Action for Continuous Profiling
22

3-
GitHub Action for Continuous Profiling which you can run to profile your workloads in CI/CD manner. It uses [Parca](https://www.parca.dev/) and Polar Signals cloud.
3+
GitHub Action for Continuous Profiling which you can run to profile your workloads in CI/CD. It uses [Polar Signals Cloud](https://www.polarsignals.com/) (or any other [Parca](https://www.parca.dev/) compatible API).
44

55
## How to use
66

7-
You will need access to Polar Signals cloud or another way to send Parca profiles to remote store.
7+
You will need access to Polar Signals Cloud or another way to send Parca profiles to remote store.
88

99
This project is also a demo of how to use this action, view the [.github/workflows](.github/workflows) directory to view the example usage.
1010

11-
If you are using Polar Signals cloud, the only thing required to configure is the `polarsignals_cloud_token` which is the API token for Polar Signals cloud, where it sends the profiling data. You can view the docs on that [here](https://www.polarsignals.com/docs/generating-tokens).
12-
13-
Profiling data from one CI run looks [like this](https://pprof.me/475d1cc/).
11+
If you are using Polar Signals Cloud, the only thing required to configure is the `polarsignals_cloud_token` which is the API token for Polar Signals Cloud, where it sends the profiling data. You can find the docs on how to obtain a token [here](https://www.polarsignals.com/docs/generating-tokens).
1412

1513
## Deployment Links
1614

17-
This action can automatically create GitHub deployments with links to your profiling data, making it easy to access the results directly from your GitHub repository. For this feature to work, the following parameters must be configured:
18-
19-
- `project_uuid`: Your Polar Signals Cloud project UUID
20-
- `github_token`: A GitHub token with the necessary permissions to create deployments to create the link to the profiling data on a Pull Request or commit.
15+
This action can automatically create GitHub deployments with links to your profiling data, making it easy to access the results directly from your GitHub repository. For this feature to work, the `project_uuid`, your Polar Signals Cloud project UUID is required. This UUID is not sensitive and can be provided directly in the workflow file, not as a secret, it ends up in the URL either way so there's no point in using a secret.
2116

22-
If any of the required parameters are missing, the deployment creation will be skipped without failing the workflow, and log messages will indicate the reason.
17+
If any of the required parameters are missing or the defaults don't work, the deployment creation will be skipped without failing the workflow, and log messages will indicate the reason.
2318

2419
### Required Permissions
2520

@@ -51,7 +46,8 @@ jobs:
5146
with:
5247
polarsignals_cloud_token: ${{ secrets.POLARSIGNALS_CLOUD_TOKEN }}
5348
project_uuid: 'your-project-uuid-here' # Don't use a secret for this, it's not sensitive, and otherwise the URL will be partially redacted.
54-
labels: ref_name=${{ github.ref_name }};workflow=${{ github.workflow }};gh_run_id=${{ github.run_id }}
55-
github_token: "${{ github.token }}"
5649
```
5750
51+
### Example Profiling Data
52+
53+
Profiling data from one CI run looks [like this](https://pprof.me/475d1cc/).

0 commit comments

Comments
 (0)