Skip to content
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.

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

Spelling #2543

Merged
merged 81 commits into from
Nov 21, 2024
Merged
Show file tree
Hide file tree
Changes from 78 commits
Commits
Show all changes
81 commits
Select commit Hold shift + click to select a range
1e41a61
link: brew.sh
jsoref Nov 17, 2024
0c74d79
link: contributing and building flank
jsoref Nov 17, 2024
c0ea8b0
link: downloads.rclone.org
jsoref Nov 17, 2024
75612c1
link: flutter integration test plugin documentation with example
jsoref Nov 17, 2024
02d76c0
link: gist.github.com/gitaarik/8735255
jsoref Nov 17, 2024
e9958c2
link: git-annex install
jsoref Nov 17, 2024
498068f
link: git-annex special_remotes
jsoref Nov 17, 2024
e7f5ee3
link: git-annex-remote-rclone
jsoref Nov 17, 2024
a012202
link: git-annex
jsoref Nov 17, 2024
72f43bd
link: git-lfs.github.com
jsoref Nov 17, 2024
88a9baf
link: github at git-annex
jsoref Nov 17, 2024
c24aa5a
link: github.com/dropbox/hypershard-android
jsoref Nov 17, 2024
f4727bf
link: minimum viable product
jsoref Nov 17, 2024
1f01075
link: test_runner/flank.yml
jsoref Nov 17, 2024
82fdad3
link: wavezhang
jsoref Nov 17, 2024
cc7f978
spelling: exection [API]
jsoref Nov 17, 2024
4e84e21
spelling: application
jsoref Nov 17, 2024
e42c518
spelling: assistant
jsoref Nov 17, 2024
ad92950
spelling: before
jsoref Nov 17, 2024
3fc75a4
spelling: cannot
jsoref Nov 17, 2024
1f7c688
spelling: command
jsoref Nov 17, 2024
348c3af
spelling: committed
jsoref Nov 17, 2024
37bfa21
spelling: comparison
jsoref Nov 17, 2024
3b33b7c
spelling: configuration
jsoref Nov 17, 2024
bf3bfd3
spelling: custom
jsoref Nov 17, 2024
5331ac6
spelling: default
jsoref Nov 17, 2024
8951aed
spelling: dependency
jsoref Nov 17, 2024
7660faf
spelling: environments
jsoref Nov 17, 2024
9860174
spelling: everything
jsoref Nov 17, 2024
17cb8bf
spelling: exception
jsoref Nov 17, 2024
5587b3f
spelling: executing
jsoref Nov 17, 2024
1289fb9
spelling: finalize
jsoref Nov 17, 2024
a83cf00
spelling: firebase
jsoref Nov 17, 2024
cb17d8d
spelling: fladle
jsoref Nov 17, 2024
307644f
spelling: for
jsoref Nov 17, 2024
642217d
spelling: gcloud
jsoref Nov 17, 2024
8e4373b
spelling: github
jsoref Nov 17, 2024
319f1b4
spelling: greater
jsoref Nov 17, 2024
a0808ea
spelling: incompatible
jsoref Nov 17, 2024
c3e9543
spelling: initial
jsoref Nov 17, 2024
c621eab
spelling: instantiation
jsoref Nov 17, 2024
477a2e3
spelling: integration
jsoref Nov 17, 2024
997734c
spelling: intellij
jsoref Nov 17, 2024
539b480
spelling: junit
jsoref Nov 17, 2024
882ca0c
spelling: macos
jsoref Nov 17, 2024
4618051
spelling: maintenance
jsoref Nov 17, 2024
0fcc6bb
spelling: management
jsoref Nov 17, 2024
78b28a4
spelling: method
jsoref Nov 17, 2024
390feac
spelling: misspelt
jsoref Nov 17, 2024
8ce8aac
spelling: n't
jsoref Nov 17, 2024
b146991
spelling: necessarily
jsoref Nov 17, 2024
46a863e
spelling: occurred
jsoref Nov 17, 2024
8eaaf96
spelling: officially
jsoref Nov 17, 2024
136078b
spelling: parameterized
jsoref Nov 17, 2024
1342625
spelling: portrait
jsoref Nov 17, 2024
49b1964
spelling: project
jsoref Nov 17, 2024
0388d2d
spelling: property
jsoref Nov 17, 2024
4f7ddab
spelling: proposition
jsoref Nov 17, 2024
8968f07
spelling: remains
jsoref Nov 17, 2024
7c29c1b
spelling: seeding
jsoref Nov 17, 2024
6a9f86b
spelling: serialized
jsoref Nov 17, 2024
af78ae8
spelling: serializer
jsoref Nov 17, 2024
6408291
spelling: signature
jsoref Nov 17, 2024
f2d8139
spelling: snapshot
jsoref Nov 17, 2024
a1a6c37
spelling: software
jsoref Nov 17, 2024
13f5b95
spelling: specification
jsoref Nov 17, 2024
ca91057
spelling: specify
jsoref Nov 17, 2024
ce239ee
spelling: subsystem
jsoref Nov 17, 2024
908a711
spelling: suppress
jsoref Nov 17, 2024
fdb38f0
spelling: swift
jsoref Nov 17, 2024
3b424c1
spelling: test
jsoref Nov 17, 2024
8276272
spelling: the
jsoref Nov 17, 2024
308eb7e
spelling: they
jsoref Nov 17, 2024
fe89972
spelling: thumbnail
jsoref Nov 17, 2024
73a7c29
spelling: timed out
jsoref Nov 17, 2024
6c8b5b5
spelling: unsupported
jsoref Nov 17, 2024
2a7ec0d
spelling: verify
jsoref Nov 17, 2024
54941cd
spelling: version
jsoref Nov 17, 2024
c92758f
spelling: kaibolay
jsoref Nov 19, 2024
132d9a5
Merge branch 'master' into spelling
kaibolay Nov 21, 2024
abdd9b6
Merge branch 'master' into spelling
kaibolay Nov 21, 2024
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
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
2 changes: 1 addition & 1 deletion .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
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
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm deleting this file in another PR...

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 @@ -25,7 +25,7 @@ jobs:
- uses: actions/checkout@v4
- uses: gradle/wrapper-validation-action@v3

- name: Gradle Upload to Github packages and Github release
- name: Gradle Upload to GitHub packages and GitHub release
uses: gradle/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down
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 @@ -25,7 +25,7 @@ jobs:
- uses: actions/checkout@v4
- uses: gradle/wrapper-validation-action@v3

- name: Gradle Upload to Github packages and Github release
- name: Gradle Upload to GitHub packages and GitHub release
uses: gradle/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down
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
4 changes: 2 additions & 2 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 @@ -101,7 +101,7 @@ jobs:
body: "Firebase Api update"
labels: |
automated pr
firease_api
firebase_api
reviewers: adamvduke,jakeouellette,tonybaroneee
draft: false

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 @@ -67,7 +67,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
26 changes: 13 additions & 13 deletions docs/flank-github-action/flank_github_acton_sdd.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# Flank Github action
# Flank GitHub action

Add Github action which allows running Flank
Add GitHub action which allows running Flank

# References

- [Github actions documentation](https://github.com/features/actions)
- [GitHub actions documentation](https://github.com/features/actions)

- [Creating a Docker container action](https://docs.github.com/en/actions/creating-actions/creating-a-docker-container-action)

- [Creating a JavaScript action](https://docs.github.com/en/actions/creating-actions/creating-a-javascript-action)

- [Creating a composite run steps action](https://docs.github.com/en/actions/creating-actions/creating-a-composite-run-steps-action)

- [Github actions marketplace](https://github.com/marketplace?type=actions)
- [GitHub actions marketplace](https://github.com/marketplace?type=actions)



# Motivation

Bitrise and Circle CI have steps in their CIs to run Flank. As Github is a widely used code repository and Github actions become more and more popular there should be also Github action that allows running Flank.
Bitrise and Circle CI have steps in their CIs to run Flank. As GitHub is a widely used code repository and GitHub actions become more and more popular there should be also GitHub action that allows running Flank.

After creating Github action, Flank could reach more users.
After creating GitHub action, Flank could reach more users.

# Goals

Expand All @@ -30,7 +30,7 @@ After creating Github action, Flank could reach more users.

# Design

There should be a possibility to specify all flank options using Github action variables as input, as well as passing the configuration itself.
There should be a possibility to specify all flank options using GitHub action variables as input, as well as passing the configuration itself.

User must provide at least:

Expand All @@ -41,13 +41,13 @@ User must provide at least:

# API

Flank Github action will be developed using [composite run steps action](https://docs.github.com/en/actions/creating-actions/creating-a-composite-run-steps-action) which just packs other actions and runs it as a single action.
Flank GitHub action will be developed using [composite run steps action](https://docs.github.com/en/actions/creating-actions/creating-a-composite-run-steps-action) which just packs other actions and runs it as a single action.

### Design proposal

```yaml
name: 'Flank'
description: 'Run Flank from Github actions!'
description: 'Run Flank from GitHub actions!'
inputs:
version:
description: 'Version of flank to run'
Expand Down Expand Up @@ -80,10 +80,10 @@ runs:
run: <download flank>
shell: bash
- id: validate configuration
run: <check if configuation file or any options are specified>
run: <check if configuration file or any options are specified>
shell: bash
- id: run flank
run: <check if configuation file or any options are specified>
run: <check if configuration file or any options are specified>
shell: bash
- id: report
run: <show run report to user>
Expand Down Expand Up @@ -143,15 +143,15 @@ jobs:

# Results

After finishing Flank GitHub actions should be published to [Github actions marketplace](https://github.com/marketplace?type=actions).
After finishing Flank GitHub actions should be published to [GitHub actions marketplace](https://github.com/marketplace?type=actions).

There should be also an announcement on Flank channel on Slack.

The thing to consider is also using it for our internal verification together with integration tests

# Dependencies

Github action needs to have `action.yml` file in the root of the repository, however, Flank repository has the file for posting Slack message after release. However it is only used by Flank team, so it will be best to move it as a side repository and keep the main Flank action in Flank's mono repository
GitHub action needs to have `action.yml` file in the root of the repository, however, Flank repository has the file for posting Slack message after release. However it is only used by Flank team, so it will be best to move it as a side repository and keep the main Flank action in Flank's mono repository

# Testing

Expand Down
2 changes: 1 addition & 1 deletion docs/flank-github-action/store_documentation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Action

This Github action allows for running Flank as a Github workflow.
This GitHub action allows for running Flank as a GitHub workflow.

Documentation for Flank is at [flank.github.io/flank](https://flank.github.io/flank/)

Expand Down
Loading
Loading