Skip to content

Use codecov token in the build pipeline + Update readme #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 13, 2025
Merged

Use codecov token in the build pipeline + Update readme #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
71cbc8f
use codecov token in the build pipeline
AdwaitChavan Oct 10, 2025
c29da9c
add code coverage details to readme
AdwaitChavan Oct 10, 2025
9143041
add a badge for codecov to the readme
AdwaitChavan Oct 13, 2025
5b1679a
use upstream repo config instead of fork
AdwaitChavan Oct 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,4 +135,5 @@ jobs:
- name: Upload Code Coverage Report
uses: codecov/codecov-action@v4
with:
files: ${{ github.workspace }}/build/reports/kover/report.xml
files: ${{ github.workspace }}/build/reports/kover/report.xml
token: ${{ secrets.CODECOV_TOKEN }}
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Secure Gateway Tunneler

[![codecov](https://codecov.io/github/salesforce/secure-pomerium-tunneler/graph/badge.svg?token=R0HHUDVA30)](https://codecov.io/github/salesforce/secure-pomerium-tunneler)

<!-- Plugin description -->
A Jetbrains Gateway plugin which handles authentication and tunneling through to a
[Pomerium](https://pomerium.io) route for connecting to a IntelliJ backend.
Expand All @@ -14,10 +16,20 @@ links. This provider requires the following parameters in the links query parame
2) `connectionKey`: A URL encoded join link provided by the backend.
for example, by using `remote-dev-server.sh status`. It will be the one that looks like
`tcp://127.0.0.1:5990#jt=...`
3) `pomeriumInstance`: (Optional) a hostname of the pomerium instance to use. By default
3) `pomeriumInstance`: (Optional) a hostname of the pomerium instance to use. By default,
the `pomeriumRoute` will be used to connect, but if DNS does not point to pomerium, this can be used

In addition, this plugin implements `GatewayConnector` to allow connecting using the
instance via the `jetbrains-gateway://` link without going through the browser (useful for testing)

## Code Coverage

This project uses [Codecov](https://about.codecov.io/) for test coverage metrics, integrated via GitHub Actions.
Coverage reports are generated on every build and uploaded to Codecov for visualization and tracking.

For protected branches (e.g., main), a Codecov upload token is required and already configured as a
repository secret (`CODECOV_TOKEN`). If you fork this repository or set up a similar workflow, add your
own token as a secret and ensure coverage reports are generated at `build/reports/kover/report.xml`.
For more details, see the [Codecov docs](https://docs.codecov.com/docs/codecov-tokens).


Loading