Skip to content

Commit

Permalink
chore: increase version
Browse files Browse the repository at this point in the history
  • Loading branch information
Ma11hewThomas committed Dec 16, 2024
1 parent 7da2b40 commit 8a543d8
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 31 deletions.
35 changes: 7 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ Thank you! Your support is invaluable to us! 💙
Analysis.
- **View AI summaries**: View AI generated summaries to help resolve failed
tests.
- **Customizable Reports:** Build and customize your own test summary reports to
fit specific project requirements.
- **Build Your Own Reports:** Build and customize your own test summary reports
to fit specific project requirements.
- **Broad Framework Support:** Compatible with all major testing frameworks
through standardized CTRF reports.
- **Easy Setup and Use:** Run the tool with a simple command: npx
Expand Down Expand Up @@ -86,7 +86,7 @@ jobs:
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Run CTRF annotations
- name: Generate Report
run: npx github-actions-ctrf path-to-your-ctrf-report.json
if: always()
```
Expand Down Expand Up @@ -258,7 +258,7 @@ workflow yaml:

Requires artifact upload

### Generating a Custom Summary
### Generating a Custom Report

To use a custom summary using a handlebars template, add the `custom` command to
your workflow:
Expand Down Expand Up @@ -370,30 +370,9 @@ argument to your command.
The GITHUB_TOKEN is typically available by default in GitHub Actions, but it
needs to have write permissions for pull requests. For guidance on configuring
these permissions, please see GitHub's
[documentation](https://docs.github.com/en/actions/security-for-github-actions/security-guides/automatic-token-authentication#permissions-for-the-github_token).

### For GitHub Enterprise Server Users

If you are using GitHub Enterprise Server, you need to specify the base URL of
your GitHub Enterprise instance. Use the `--domain` argument to provide this
URL:

```yaml
- name: Post PR Comment on GitHub Enterprise Server
run:
npx github-actions-ctrf ctrf-report.json --pr-comment --domain
https://your-enterprise-domain.com
if: always()
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```

Replace <https://your-enterprise-domain.com> with the base URL of your GitHub
Enterprise Server instance. The GITHUB_TOKEN used must have appropriate
permissions on the GitHub Enterprise Server instance. For more details, refer to
the
[documentation](https://docs.github.com/en/actions/security-for-github-actions/security-guides/automatic-token-authentication#permissions-for-the-github_token)
or
[GitHub Enterprise Server documentation](https://docs.github.com/en/enterprise-server@3.14/actions/security-for-github-actions/security-guides/automatic-token-authentication#about-the-github_token-secret)
on configuring tokens and permissions.

## Previous Test Results

Expand Down Expand Up @@ -451,7 +430,7 @@ add the following to your workflow yaml:
if: always()
```

### Writing a Handlebars Markdown Template
### Build Your Own Report

Creating a Handlebars markdown template allows you to have full control over how
your test results are displayed. With Handlebars and CTRF, you can inject
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "github-actions-ctrf",
"version": "0.0.50-rc.6",
"version": "0.0.51",
"description": "View test results directly within your GitHub workflow summary and Pull Requests",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit 8a543d8

Please sign in to comment.