Skip to content

Adjust to app.mayhem.security. #116

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
eddymul merged 5 commits into from
Jun 17, 2023
Merged

Adjust to app.mayhem.security. #116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a352aa5
Adjust to app.mayhem.security.
eddymul Jun 15, 2023
df4171f
dist/index.js: Adjust to app.mayhem.security.
eddymul Jun 15, 2023
a143f33
dist/index.js*: make dist-rebuild
eddymul Jun 15, 2023
e889175
README.md: Update.
eddymul Jun 16, 2023
8230a9b
Apply suggestions from code review
eddymul Jun 16, 2023
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
24 changes: 13 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Mayhem for Code GitHub Action

[![Mayhem for Code](https://drive.google.com/uc?export=view&id=1JXEbfCDMMwwnDaOgs5-XlPWQwZR93fv4)](http://mayhem.forallsecure.com/)
[![Mayhem for Code](https://drive.google.com/uc?export=view&id=1JXEbfCDMMwwnDaOgs5-XlPWQwZR93fv4)](http://app.mayhem.security/)

A GitHub Action for using Mayhem for Code to check for reliability, performance and security issues in your application binary (packaged as a containerized [Docker](https://docs.docker.com/get-started/overview/) image).

Expand All @@ -12,20 +12,22 @@ A GitHub Action for using Mayhem for Code to check for reliability, performance

🤖 Simple to Automate in CI: Tests belong in CI, running on every commit and PRs. We make it easy, and provide results right in your PRs where you want them. Adding Mayhem for Code to a DevOps pipeline is easy.

Want to try it? [Get started for free](https://forallsecure.com/mayhem-free) today!
Want to try it? [Get started for free](https://www.mayhem.security/get-started) today!

## Getting Started

To use the Mayhem for Code GitHub Action, perform the following steps:

1. Navigate to [mayhem.forallsecure.com](https://mayhem.forallsecure.com/) to register an account.
1. Navigate to [app.mayhem.security](https://app.mayhem.security/) to register an account.

1. Click your profile drop-down and go to *Settings* > *API Tokens* to access your account API token.
1. After logging in, on the bottom left:
1. Click your profile icon.
2. Click Account Settings.
2. Switch to *API Tokens* section to access your account API token.

2. Copy and paste your Mayhem token to your repo's [GitHub Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-an-organization). You will need the following secrets configured for your repository:
3. Copy and paste your Mayhem token to your repo's [GitHub Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-an-organization). You will need the following secrets configured for your repository:

* `MAYHEM_TOKEN`: Your Mayhem account API token.
* `MAYHEM_URL`: The URL of the Mayhem instance, such as `https://mayhem.forallsecure.com`.

2. Create a `mayhem.yml` file in your GitHub repository located at:

Expand Down Expand Up @@ -152,9 +154,9 @@ The mCode Action accepts the following inputs:

| Required | Input Name | Type | Description | Default
| --- | --- | --- | --- | ---
| | `mayhem-url` | string | Path to a custom Mayhem for Code instance. | https://mayhem.forallsecure.com |
| | `mayhem-url` | string | Path to a custom Mayhem for Code instance. | https://app.mayhem.security |
| | `mayhem-token` | string | Mayhem for Code account token. **Only required within** `mayhem.yml` **if overriding** `mayhem-url`. |
| | `args` | string | Additional CLI override [arguments](https://mayhem.forallsecure.com/docs/mayhem-cli/getting-started/mayhem-cli-commands/#run) such as specifying the `--testsuite` directory path for a seed test suite. |
| | `args` | string | Additional CLI override [arguments](https://app.mayhem.security/docs/code-testing/reference/mayhem-cli-commands/#run) such as specifying the `--testsuite` directory path for a seed test suite. |
| | `sarif-output` | string | Path for generating a SARIF report output file. |
| | `junit-output` | string | Path for generating a jUnit report output file. |
| | `coverage-output` | string | Path for generating a coverage report output files. |
Expand All @@ -165,7 +167,7 @@ The mCode Action provides the following outputs:
| `runId` | string | The identifier of the run that this action triggered in Mayhem. |


📖 See the [CI/CD](https://mayhem.forallsecure.com/docs/mayhem-ci-cd/fuzzing-in-your-pipeline/) docs for more information and guides on using the mCode GitHub Action!
Copy link
Member

@ethan42 ethan42 Jun 16, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

at the end of the readme there are also some references to forallsecure.com. I would recommend changing them to mayhem.security.

Copy link
Contributor Author

@eddymul eddymul Jun 16, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be resolved in e889175

But, would appreciate another look. 🙏

📖 See the [GitHub Action Integration](https://app.mayhem.security/docs/integrations/ci-integrations/github/) docs for more information and guides on using the mCode GitHub Action!

## Reports and GitHub Code Scanning

Expand Down Expand Up @@ -193,6 +195,6 @@ Finally, push your changes and submit a pull request from your forked repository

ForAllSecure was founded with the mission to make the world’s critical software safe. The company has been applying its patented technology from over a decade of CMU research to solving the difficult challenge of making software safer. ForAllSecure has partnered with Fortune 1000 companies in aerospace, automotive and high-tech industries, as well as the US Department of Defense to integrate Mayhem into software development cycles for continuous security. Profitable and revenue-funded, the company is scaling rapidly.

* [https://forallsecure.com/](https://forallsecure.com/)
* [https://forallsecure.com/mayhem-for-code](https://forallsecure.com/mayhem-for-code)
* [https://mayhem.security/](https://mayhem.security/)
* [https://www.mayhem.security/code-security](https://www.mayhem.security/code-security)
* [https://community.forallsecure.com/](https://community.forallsecure.com/)
Loading