Skip to content

Commit

Permalink
Spelling (#2543)
Browse files Browse the repository at this point in the history
https://www.check-spelling.dev/

---------

Signed-off-by: Josh Soref <[email protected]>
Co-authored-by: Kai Bolay <[email protected]>
  • Loading branch information
jsoref and kaibolay authored Nov 21, 2024
1 parent d828415 commit 1e0f124
Show file tree
Hide file tree
Showing 113 changed files with 274 additions and 274 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ on:
schedule:
- cron: '32 22 * * 6'

permissions: # limit the permissions of the GITHIUB_TOKEN to reading repository contents
permissions: # limit the permissions of the GITHUB_TOKEN to reading repository contents
contents: read

jobs:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/generate_release_notes.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: "[Release] Step 1: Generate release notes"
on:
workflow_dispatch:

# limit the permissions of the GITHIUB_TOKEN to reading repository contents
# limit the permissions of the GITHUB_TOKEN to reading repository contents
# the subsequent pull request uses a token from the 'generate-token' step
permissions:
contents: read
Expand Down Expand Up @@ -55,6 +55,6 @@ jobs:
labels: |
automated pr
release
reviewers: adamvduke,jakeouellette,tonybaroneee
reviewers: kaibolay,jakeouellette,tonybaroneee
owners
draft: false
2 changes: 1 addition & 1 deletion .github/workflows/integration_tests_pointer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
repository_dispatch:
types: [ integration-pointer]

permissions: # limit the permissions of the GITHIUB_TOKEN to reading repository contents
permissions: # limit the permissions of the GITHUB_TOKEN to reading repository contents
contents: read

jobs:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/macos_workflow.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
branches:
- '*'

permissions: # limit the permissions of the GITHIUB_TOKEN to reading repository contents
permissions: # limit the permissions of the GITHUB_TOKEN to reading repository contents
contents: read

jobs:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ on:
tags: v*

# TODO: update workflow permissions to least privilege after auditing all the APIs used
# permissions: # limit the permissions of the GITHIUB_TOKEN to reading repository contents
# permissions: # limit the permissions of the GITHUB_TOKEN to reading repository contents
# contents: read

jobs:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/release_flank_scripts.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
- 'master'

# TODO: update workflow permissions to least privilege after auditing all the APIs used
# permissions: # limit the permissions of the GITHIUB_TOKEN to reading repository contents
# permissions: # limit the permissions of the GITHUB_TOKEN to reading repository contents
# contents: read

jobs:
Expand All @@ -28,7 +28,7 @@ jobs:
- name: Setup Gradle
uses: gradle/actions/setup-gradle@v4

- name: Gradle Upload to Github packages and Github release
- name: Gradle Upload to GitHub packages and GitHub release
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: ./gradlew flank-scripts:releaseFlankScripts -PGITHUB_TOKEN="$GH_TOKEN"
4 changes: 2 additions & 2 deletions .github/workflows/release_flank_wrapper.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
- 'master'

# TODO: update workflow permissions to least privilege after auditing all the APIs used
# permissions: # limit the permissions of the GITHIUB_TOKEN to reading repository contents
# permissions: # limit the permissions of the GITHUB_TOKEN to reading repository contents
# contents: read

jobs:
Expand All @@ -28,7 +28,7 @@ jobs:
- name: Setup Gradle
uses: gradle/actions/setup-gradle@v4

- name: Gradle Upload to Github packages and Github release
- name: Gradle Upload to GitHub packages and GitHub release
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: ./gradlew flank-wrapper:releaseFlankWrapper -PGITHUB_TOKEN="$GH_TOKEN"
2 changes: 1 addition & 1 deletion .github/workflows/run_integration_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
workflow_dispatch: # or manually

# TODO: update workflow permissions to least privilege after auditing all the APIs used
# permissions: # limit the permissions of the GITHIUB_TOKEN to reading repository contents
# permissions: # limit the permissions of the GITHUB_TOKEN to reading repository contents
# contents: read

jobs:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/tag_next_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
types: [ closed ]

# TODO: update workflow permissions to least privilege after auditing all the APIs used
# permissions: # limit the permissions of the GITHIUB_TOKEN to reading repository contents
# permissions: # limit the permissions of the GITHUB_TOKEN to reading repository contents
# contents: read

jobs:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ubuntu_workflow.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:
branches:
- '*'

permissions: # limit the permissions of the GITHIUB_TOKEN to reading repository contents
permissions: # limit the permissions of the GITHUB_TOKEN to reading repository contents
contents: read

jobs:
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/update_dependencies.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on:
workflow_dispatch:

# TODO: update workflow permissions to least privilege after auditing all the APIs used
# permissions: # limit the permissions of the GITHIUB_TOKEN to reading repository contents
# permissions: # limit the permissions of the GITHUB_TOKEN to reading repository contents
# contents: read

jobs:
Expand Down Expand Up @@ -58,7 +58,7 @@ jobs:
labels: |
automated pr
dependencies
reviewers: adamvduke,jakeouellette,tonybaroneee
reviewers: kaibolay,jakeouellette,tonybaroneee
draft: false

update_firebase_api:
Expand Down Expand Up @@ -102,8 +102,8 @@ jobs:
body: "Firebase Api update"
labels: |
automated pr
firease_api
reviewers: adamvduke,jakeouellette,tonybaroneee
firebase_api
reviewers: kaibolay,jakeouellette,tonybaroneee
draft: false

check_for_sdk_updates:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/update_dependencies_pointer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
repository_dispatch:
types: [ dependencies-pointer ]

permissions: # limit the permissions of the GITHIUB_TOKEN to reading repository contents
permissions: # limit the permissions of the GITHUB_TOKEN to reading repository contents
contents: read

jobs:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/windows_workflow.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ on:
branches:
- '*'

permissions: # limit the permissions of the GITHIUB_TOKEN to reading repository contents
permissions: # limit the permissions of the GITHUB_TOKEN to reading repository contents
contents: read

jobs:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ Flank is YAML compatible with [the gcloud CLI](https://cloud.google.com/sdk/gclo
### Documentation is at [flank.github.io/flank](https://flank.github.io/flank/)


### Github action documentation is at [repository](https://github.com/Flank/flank/blob/master/docs/flank-github-action/store_documentation.md)
### GitHub action documentation is at [repository](https://github.com/Flank/flank/blob/master/docs/flank-github-action/store_documentation.md)
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: 'Flank'
description: 'Run Flank from Github actions!'
description: 'Run Flank from GitHub actions!'
inputs:
version:
description: 'Flank version to run'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ class CheckVersionUpdated : Plugin<Project> {

val localResultsStream = execAndGetStdout("git", "diff", "origin/master", "HEAD", "--", "build.gradle.kts")
.split("\n")
val commitedResultsStream = execAndGetStdout("git", "diff", "origin/master", "--", "build.gradle.kts")
val committedResultsStream = execAndGetStdout("git", "diff", "origin/master", "--", "build.gradle.kts")
.split("\n")
return (commitedResultsStream + localResultsStream)
return (committedResultsStream + localResultsStream)
.filter { it.startsWith("-version = ") || it.startsWith("+version = ") }
.isNotEmpty()
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ open class CheckVersionUpdatedTask : DefaultTask() {
private fun Project.isVersionChangedInBuildGradle(): Boolean {
val localResultsStream = execAndGetStdout("git", "diff", "origin/master", "HEAD", "--", "build.gradle.kts")
.split("\n")
val commitedResultsStream = execAndGetStdout("git", "diff", "origin/master", "--", "build.gradle.kts")
val committedResultsStream = execAndGetStdout("git", "diff", "origin/master", "--", "build.gradle.kts")
.split("\n")
return (commitedResultsStream + localResultsStream)
return (committedResultsStream + localResultsStream)
.any { it.startsWith("-version = ") || it.startsWith("+version = ") }
}

Expand Down
6 changes: 3 additions & 3 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,16 @@ There is a [`Debug.kt`](https://github.com/Flank/flank/blob/master/test_runner/s

Note: The breakpoints will only hit for the actual command being run. For example, for `firebase test android run`, the debugger will directly enter [`AndroidRunCommand`](https://github.com/Flank/flank/blob/master/test_runner/src/main/kotlin/ftl/cli/firebase/test/android/AndroidRunCommand.kt).

The yml file being read is located [here](https://github.com/Flank/flank/blob/master/test_runner/flank.yml).
The yml file being read is located at [test_runner/flank.yml](https://github.com/Flank/flank/blob/master/test_runner/flank.yml).

Run `./gradlew check` to fix lint issues

## Adding new gcloud property common to iOS and Android

- Add property to `GcloudYml` and update `keys` in config files
- Update `IArgs` with new property
- Update `AndroidArgs` to reference the propery and update `toString`
- Update `IosArgs` to reference the propery and `toString`
- Update `AndroidArgs` to reference the property and update `toString`
- Update `IosArgs` to reference the property and `toString`
- Add test to `IosArgsTest`
- Add test to `IosRunCommandTest` and update `empty_params_parse_null` test
- Add test to `AndroidArgsTest`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ But when user back to old configuration, he can still reproduce problem.

#### Issue reported to TeamCity https://youtrack.jetbrains.com/issue/TW-66753

TeamCity team cannot reproduce the problem, thay asked about additional logs, but User could deliver them in next week (starting 13-07-2020), until that we must wait.
TeamCity team cannot reproduce the problem, they asked about additional logs, but User could deliver them in next week (starting 13-07-2020), until that we must wait.



Expand Down
4 changes: 2 additions & 2 deletions docs/bugs/891-rate-limit-exceeded.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ forEach(test matrix) {
}
```

## API calls usage comparision table
## API calls usage comparison table
Following table should compare API calls complexity.

| | execution status updates |
Expand All @@ -219,7 +219,7 @@ E - count of test executions in matrix scope
```

## Conclusions
#### Gclud
#### Gcloud
Because of single matrix run gives only 1 request per 6 seconds

#### Flank v20.05.2
Expand Down
2 changes: 1 addition & 1 deletion docs/bugs/993_multiple_identical_lines_printing.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ It always executes on the same thread so it is not a concurrency issue

- [X] on ```ExecutionStatusPrinter.kt``` -> ```MultiLinePrinter``` try to force add to output two same ExecutionStatus but no effect

- [X] on ```GcTestMatrix.kt``` -> ```refresh()``` try to add testSpecyfication with same id but without effect
- [X] on ```GcTestMatrix.kt``` -> ```refresh()``` try to add testSpecification with same id but without effect
4 changes: 2 additions & 2 deletions docs/bugs/null_no_tests_found.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ gcloud:
use-orchestrator: true
```
## Reported flade config
## Reported fladle config
```groovy
fladle {
serviceAccountCredentials = file("pathToCredentials")
Expand Down Expand Up @@ -120,4 +120,4 @@ fladle {
* Create multi-module project which will provide many test apks and try to reproduce issue.
* Ensure that our knowledge about issue in `What we know from report issue` is correct.
* Based on: https://stackoverflow.com/questions/39241640/android-instrumented-test-no-tests-found try to make real multi dex app and try trun tests on it
* Play with @BefeoreClass and @Before annotations (exception on @BeforeClass produce null without test cases on test-lab).
* Play with @BeforeClass and @Before annotations (exception on @BeforeClass produce null without test cases on test-lab).
2 changes: 1 addition & 1 deletion docs/building_updating_flank.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Building and Updating Flank
Ensure that all steps taken for contributing and building Flank have been followed, which are found [here](../README.md)
Ensure that you have followed all steps for [contributing and building Flank](../README.md)

## Building an updated flank
To build an updated version of flank from source simply run (This assumes you are in the root Flank directory)
Expand Down
4 changes: 2 additions & 2 deletions docs/client_generation.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Google API clients (`google-api-*-client`)
- Low level
- Auto generated
- Made for JSON REST APIs
- Older project - [maintence mode](https://github.com/GoogleCloudPlatform/google-cloud-ruby/issues/1604#issuecomment-316834237)
- Older project - [maintenance mode](https://github.com/GoogleCloudPlatform/google-cloud-ruby/issues/1604#issuecomment-316834237)

Google APIs toolkit (`googleapis/toolkit`)
- Low level
Expand All @@ -36,7 +36,7 @@ Google Cloud libraries (`google-cloud-*`)
- [google-api-go-client](https://github.com/google/google-api-go-client)
- [google-api-go-generator](https://github.com/google/google-api-go-client/tree/master/google-api-go-generator)
- [google-api-java-client](https://github.com/google/google-api-java-client)
- [google-api-javascript-client](https://github.com/google/google-api-javascript-client) - not offically [marked as maintence,](https://github.com/google/google-api-javascript-client/issues/320) however no new updates since May 2017.
- [google-api-javascript-client](https://github.com/google/google-api-javascript-client) - not officially [marked as maintenance,](https://github.com/google/google-api-javascript-client/issues/320) however no new updates since May 2017.
- [google-api-dotnet-client](https://github.com/google/google-api-dotnet-client)
- [google-api-objectivec-client](https://github.com/google/google-api-objectivec-client)
- Deprecated. Replaced entirely by [google-api-objectivec-client-for-rest](https://github.com/google/google-api-objectivec-client-for-rest)
Expand Down
6 changes: 3 additions & 3 deletions docs/dependencies_update_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Process run commands and update files with defined versions in the provided file
### Modules
0. [Gradle Versions Plugin](https://github.com/ben-manes/gradle-versions-plugin) which check dependencies version and generate report
0. [Command](../flank-scripts/README.md#dependencies) in `flank-scripts` which update dependencies versions
0. Github action job which runs dependencies check every Monday at 5 AM UTC or on-demand
0. GitHub action job which runs dependencies check every Monday at 5 AM UTC or on-demand

## Usage

Expand All @@ -15,8 +15,8 @@ Process run commands and update files with defined versions in the provided file
0. Build flank scripts using script `./flank-scripts/bash/buildFlankScripts.sh`
0. Run `./flank-scripts/bash/flankScripts dependencies update`

### Github action
Run `Update dependencies` job using [Github action menu](https://github.com/Flank/flank/actions) by clicking `Run workflow` button
### GitHub action
Run `Update dependencies` job using [GitHub action menu](https://github.com/Flank/flank/actions) by clicking `Run workflow` button

## Merging to master

Expand Down
2 changes: 1 addition & 1 deletion docs/feature/summary_output.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Gcloud is using following API calls
2. `self._client.projects_histories_executions_steps.List(request)`

The first one is default, but if returns any `environment` without `environmentResult.outcome`, the second one will be used to obtain `steps`.
Both `environemnts` and `steps` can provide `outcome`. The difference between them is the `steps` returns `success` event if tests are `flaky`.
Both `environments` and `steps` can provide `outcome`. The difference between them is the `steps` returns `success` event if tests are `flaky`.
Currently, we don't know why `self._client.projects_histories_executions_environments.List(request)` may return empty `environmentResult.outcome`.

In difference to gcloud flank uses 3 api call to obtain necessary data
Expand Down
Loading

0 comments on commit 1e0f124

Please sign in to comment.