Skip to content

Commit 3375547

Browse files
authored
Update README.md (#38)
* Update README.md * Update README.md
1 parent 4344bf6 commit 3375547

File tree

1 file changed

+2
-16
lines changed

1 file changed

+2
-16
lines changed

README.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ The following environment variables must be configured:
1111
| `DOCKERHUB_USERNAME` | Docker Hub username for pulling MegaLinter image | Yes |
1212
| `DOCKERHUB_PASSWORD` | Docker Hub password for pulling MegaLinter image | Yes |
1313
| `GITHUB_TOKEN` | GitHub token for MegaLinter GitHub integration | Yes |
14-
| `GIT_USER_EMAIL` | Email to use for Git operations when auto-fixing issues | No |
15-
| `GIT_USER_NAME` | Name to use for Git operations when auto-fixing issues | No |
1614

1715
## Orb Parameters
1816

@@ -26,21 +24,9 @@ The following parameters can be configured when using the orb:
2624
| `flavor` | Choose a specific flavor of megalinter (see [available flavors](https://megalinter.io/latest/flavors/)) | "" | No |
2725
| `github_token` | GitHub token to use for the reporters in megalinter | GITHUB_TOKEN | No |
2826
| `parallelism` | Number of parallel executors to use | 1 | No |
29-
| `persist_megalinter_reports` | Whether to persist the megalinter-reports folder for use in subsequent jobs | false | No |
27+
| `persist_megalinter_reports` | Whether to persist the megalinter-reports folder for use in subsequent jobs | true | No |
3028
| `entrypoint` | Change entrypoint of megalinter | "/entrypoint.sh" | No |
3129

32-
### Git Operations Parameters
33-
| Parameter | Description | Default | Required |
34-
|-----------|-------------|---------|-----------|
35-
| `run_git_operations` | Whether to run git operations to commit and push changes | false | No |
36-
| `git_user_email` | Email to use for Git | GIT_USER_EMAIL | No |
37-
| `git_user_name` | Name to use for Git | GIT_USER_NAME | No |
38-
| `git_pr_commit_message` | Commit message to use for Git | "Automated linting fixes by MegaLinter" | No |
39-
| `git_pr_title` | Title to use for the pull request | "[MegaLinter] Apply linters automatic fixes" | No |
40-
| `git_pr_branch_name` | Branch name to use for Git | "megalinter-fixes-$CIRCLE_BUILD_NUM" | No |
41-
| `git_pr_base_branch` | Boolean parameter for base branch to use for Git | false | No |
42-
| `git_pr_current_branch` | Current branch to use for Git (used only for setting up git pull request together with git_pr_base_branch) | "" | No |
43-
4430
### Security Notes
4531
- GitHub Token: Use a token with minimal required permissions (read-only access recommended)
4632
- Docker Hub: Consider using a restricted access token instead of password
@@ -99,6 +85,6 @@ A [Development Orb](https://circleci.com/docs/orb-concepts/#development-orbs) ca
9985
# Ensure this job requires all test jobs and the pack job.
10086
requires:
10187
- orb-tools/pack
102-
- megalinter/megalinter
88+
- megalinter/run
10389
context: < organization context >
10490
filters: *filters

0 commit comments

Comments
 (0)