QuintinWillison
commented
2 years ago This action should also generate deployments. This is well described in https://github.com/ably/repository-audit/issues/36.
Open QuintinWillison opened 2 years ago
QuintinWillison
commented
2 years ago This action should also generate deployments. This is well described in https://github.com/ably/repository-audit/issues/36.
h3. Actions are working for us The SDK Team here at [Ably|https://github.com/ably] starting working on Ably's first [GitHub Action|https://docs.github.com/en/actions/creating-actions/about-custom-actions#about-custom-actions] back in early 2021. You can find it at [ably/sdk-upload-action|https://github.com/ably/sdk-upload-action].
It's performing well for us and has [significantly simplified and reduced the amount of workflow script (yaml)|https://github.com/ably/ably-flutter/pull/117] that's required for us to deploy to our S3 bucket, presented at {{sdk.ably.com}}.
It makes a lot of sense for us to continue to encapsulate our patterns and processes as actions once we realise that we're using them in more than one place, or we have the opportunity to do so.
h3. {{git}} push downstream in action I've encapsulated my preference for keeping source code repositories as purely source code under https://github.com/ably/sdk-upload-action/issues/31.
That preference has been realised in a couple of places already:
ably-common|https://github.com/ably/ably-common] publishes to [ably-common-go|https://github.com/ably/ably-common-go], [because Go Modules|https://go.dev/blog/publishing-go-modules]: see [publish-go.sh, invoked from the publish workflow|https://github.com/ably/ably-common/blob/5e695725f801831fbe5523fdd27aa01986ff01fc/.github/workflows/publish.yml#L35]repository-audit|https://github.com/ably/repository-audit] publishes to [repository-audit-report-internal|https://github.com/ably/repository-audit-report-internal], because [we designed it that way|https://github.com/ably/repository-audit#how]: see [publish.sh, invoked from the run workflow|https://github.com/ably/repository-audit/blob/1e25629ee912a386b9970edf6e2820be903a0456/.github/workflows/run.yml#L46] at the time of writing this issue the {{repository-audit}} source code repository is yet to be made public (https://github.com/ably/repository-audit/issues/5) that tool will soon also publish to [repository-audit-report|https://github.com/ably/repository-audit-report] (https://github.com/ably/repository-audit/issues/24), which will be made public - the {{repository-audit-report-internal}} repository will remain privateh3. {{git}} push downstream in a GitHub Action If we consider [a typical example of usage|https://github.com/ably/ably-asset-tracking-android/blob/c8d57f0c7f8c5299db68424e9bdba12deba576cf/.github/workflows/docs.yml#L31] of our existing SDK Upload Action (workflow > job > [step|https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstepsuses]):
{code:yaml}
h4. Example: {{ably-common}} to {{ably-common-go}} {code:yaml}
uses: ably/git-publish-action@v1 with: sshPrivateKey: ${{ secrets.SSH_PRIVATE_KEY }} actingWorkflow: Common Publish sourcePath: output targetRepository: ably-common-go {code} Where:
both {{user.name}} and {{user.email}} Git configurations can be generated in the current conformed form from the single {{actingWorkflow}} argument: {{user.email}}: {{Ably Common Publish Workflow [bot]}} {{user.email}}: {{ably-common-publish-workflow[bot]@noreply.ably.com}}
h4. Example: {{repository-audit}} to {{repository-audit-report}} ({{main}} branch, 'run') Replace [this step|https://github.com/ably/repository-audit/blob/1e25629ee912a386b9970edf6e2820be903a0456/.github/workflows/run.yml#L36] with:
{code:yaml}
{code:yaml}