docs: Github action SDD proposal #1590
Conversation
|
CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅ |
piotradamczyk5
requested review from
adamfilipow92,
zuziaka,
bootstraponline,
jan-goral,
pawelpasterz and
Sloox
|
Timestamp: 2021-02-11 18:15:38 |
| with: | ||
| version: '21.01.0' | ||
| platform: 'android' | ||
| flank_service_account: './service_account.json' |
There was a problem hiding this comment.
service_account.json - shound't be kept in secrets? I am not sure, just asking.
There was a problem hiding this comment.
it will be provided by the user, so it will be his responsibility to keep it safe
There was a problem hiding this comment.
But if it's file path user should add service acc to repo or create before this step yes? Maybe we could allow users to provide a string with service acc data instead of the file path.
| name: 'Flank' | ||
| description: 'Run Flank from Github actions!' | ||
| inputs: | ||
| version: |
| description: 'Description of option 1' | ||
| required: false # validation will done when running | ||
| ... | ||
| flank_optionX: |
There was a problem hiding this comment.
Usually in Maths we denote it as 1...N its the most common way to show it.
Is X used for a reason?
|
|
||
| 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. |
|
|
||
| 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 |
There was a problem hiding this comment.
Sounds great. Always good to dogfood our own releases.
|
|
||
| # 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 |
There was a problem hiding this comment.
Please tag me in this and ill gladly move it to another repository as i was the author. It can be done alongisde me optimizaing the release notification.
Fixes #1419
This is a proposal on how to implement Github action for running Flank 🎉
Checklist