{"id":9010,"date":"2024-09-27T03:16:10","date_gmt":"2024-09-26T21:46:10","guid":{"rendered":"https:\/\/www.satup.xyz\/index.php\/2024\/09\/27\/introducing-new-github-actions-for-app-platform\/"},"modified":"2024-09-27T03:16:10","modified_gmt":"2024-09-26T21:46:10","slug":"introducing-new-github-actions-for-app-platform","status":"publish","type":"post","link":"https:\/\/www.satup.xyz\/index.php\/2024\/09\/27\/introducing-new-github-actions-for-app-platform\/","title":{"rendered":"Introducing new GitHub Actions for App Platform"},"content":{"rendered":"


\n<\/p>\n

\n

GitHub Actions is the CI\/CD platform our customers use the most for building and deploying their code. In the past, we\u2019ve provided a supported action, called app_action, that could be used to update an App that already exists via a GitHub Action.<\/p>\n

Today, we\u2019re excited to introduce completely overhauled GitHub Actions for App Platform with improved pluggability to cater to all of the deployment needs you might think of.<\/p>\n

The new deploy<\/strong> action is the heart of our GitHub Actions ecosystem. Like the old one, it allows you to update an app that already exists. However, it also does much more than that: It also allows you to completely make the respective GitHub repository the source of truth in a GitOps-style fashion. Now, you can commit an AppSpec to your GitHub repository and handle the entire deployment process via GitHub Actions. It is no longer necessary to interact with DigitalOcean directly at all (apart from generating the token for the action to use).<\/p>\n

The in-repository AppSpec can also contain environment variable placeholders that will be replaced before deploying the new spec. This can be used to update image references on the fly or to manage your secrets via Github\u2019s secret mechanism.<\/p>\n

We\u2019ve also used the opportunity to provide more integration into the GitHub Actions ecosystem. The deploy action outputs the resulting app metadata and the build and deployment logs from the deployment that took place. Optionally, those logs are also logged in the action\u2019s output itself. That metadata can be used to create rich integrations with App Platform, tailored to your specific needs.<\/p>\n

Deploy an app from GitHub<\/a><\/h3>\n

To deploy an app purely from GitHub without needing to create it out of band first is as simple as committing the respective App Spec to the repository (the action defaults to .do\/app.yaml<\/code>) and setup an action like below. This will cause the app to redeploy whenever a new commit is pushed to main (note that deploy_on_push<\/code> should be turned off in the App Spec for that matter). Any changes to the App Spec itself would also be applied.<\/p>\n

name<\/span>:<\/span> Update App\n\non<\/span>:<\/span>\n  push<\/span>:<\/span>\n    branches<\/span>:<\/span> [<\/span>main]<\/span>\n    \npermissions<\/span>:<\/span>\n  contents<\/span>:<\/span> read\n\njobs<\/span>:<\/span>\n  deploy-app<\/span>:<\/span>\n    runs-on<\/span>:<\/span> ubuntu-<\/span>latest\n    steps<\/span>:<\/span>\n      -<\/span> name<\/span>:<\/span> Checkout repository\n        uses<\/span>:<\/span> actions\/checkout@v4\n      -<\/span> name<\/span>:<\/span> Deploy the app\n        uses<\/span>:<\/span> digitalocean\/app_action\/deploy@v2\n        with<\/span>:<\/span>\n          token<\/span>:<\/span> ${<\/span>{<\/span> secrets.DIGITALOCEAN_ACCESS_TOKEN }<\/span>}<\/span>\n<\/code><\/pre>\n
Deploy an app from an image built in the GitHub Action<\/a><\/h3>\n
As a slightly more involved use-case, the below action builds an app from a Dockerfile in the repository inside the GitHub Action, not as part of the App Platform build. That image is then deployed by digest<\/strong> to ensure that this exact<\/strong> image is what\u2019s being deployed as part of the app.<\/p>\n
Note that the image digest is provided as the SAMPLE_DIGEST<\/code> environment variable here. That\u2019ll have to be referenced in the App Spec with the ${SAMPLE_DIGEST}<\/code> notation.<\/p>\n
name<\/span>:<\/span> Build,<\/span> Push and Deploy a Docker Image\n\non<\/span>:<\/span>\n  push<\/span>:<\/span>\n    branches<\/span>:<\/span> [<\/span>main]<\/span>\n\npermissions<\/span>:<\/span>\n  contents<\/span>:<\/span> read\n  packages<\/span>:<\/span> write\n\njobs<\/span>:<\/span>\n  build-push-deploy-image<\/span>:<\/span>\n    runs-on<\/span>:<\/span> ubuntu-<\/span>latest\n    steps<\/span>:<\/span>\n      -<\/span> name<\/span>:<\/span> Checkout repository\n        uses<\/span>:<\/span> actions\/checkout@v4\n      -<\/span> name<\/span>:<\/span> Log in to the Container registry\n        uses<\/span>:<\/span> docker\/login-<\/span>action@v3.3.0\n        with<\/span>:<\/span>\n          registry<\/span>:<\/span> ghcr.io\n          username<\/span>:<\/span> ${<\/span>{<\/span> github.actor }<\/span>}<\/span>\n          password<\/span>:<\/span> ${<\/span>{<\/span> secrets.GITHUB_TOKEN }<\/span>}<\/span>\n      -<\/span> name<\/span>:<\/span> Build and push Docker image\n        id<\/span>:<\/span> push\n        uses<\/span>:<\/span> docker\/build-<\/span>push-<\/span>action@v6.5.0\n        with<\/span>:<\/span>\n          context<\/span>:<\/span> .\n          push<\/span>:<\/span> true<\/span>\n          tags<\/span>:<\/span> ghcr.io\/${<\/span>{<\/span> github.repository }<\/span>}<\/span>:<\/span>latest\n      -<\/span> name<\/span>:<\/span> Deploy the app\n        uses<\/span>:<\/span> digitalocean\/app_action\/deploy@v2\n        env<\/span>:<\/span>\n          SAMPLE_DIGEST<\/span>:<\/span> ${<\/span>{<\/span> steps.push.outputs.digest }<\/span>}<\/span>\n        with<\/span>:<\/span>\n          token<\/span>:<\/span> ${<\/span>{<\/span> secrets.DIGITALOCEAN_ACCESS_TOKEN }<\/span>}<\/span>\n<\/code><\/pre>\n
Note that the image digest is provided as the SAMPLE_DIGEST<\/code> environment variable here. That\u2019ll have to be referenced in the App Spec with the ${SAMPLE_DIGEST}<\/code> notation like so.<\/p>\n
name<\/span>:<\/span> sample\n\nservices<\/span>:<\/span>\n-<\/span> name<\/span>:<\/span> sample\n image<\/span>:<\/span>\n   registry_type<\/span>:<\/span> GHCR\n   registry<\/span>:<\/span> YOUR_ORG\n   repository<\/span>:<\/span> YOUR_REPO\n   digest<\/span>:<\/span> ${<\/span>SAMPLE_DIGEST}<\/span>\n<\/code><\/pre>\n
Pull request previews<\/a><\/h3>\n
And lastly, pull request previews is a great example of the power of orchestratability. This feature allows you to deploy a new app for every pull request and surface the respective live URL [1] and the respective build [2] and deployment [3] logs to the pull request author, avoiding merging code that breaks the app in production.<\/p>\n
With the new deploy action, creating such an integration in your repository becomes trivial. It comes with a specialized \u201cPR-preview-mode\u201d, which generates a unique app name for each pull request, sanitizes the app spec of potentially conflicting resources (for example, it drops domains and alerts), and updates all potential GitHub references to point to the respective PR\u2019s branch.<\/p>\n
Conversely, there\u2019s also a new delete action, that allows you to delete apps again. Usually, this is done when a pull request is closed or merged to clean up resources.<\/p>\n
Equipped with that, you can imagine an action like the below, which will deploy an app per pull request and upon successful deployment, will post a comment to the pull request with a link to the app. On failure, it will post a link to the action\u2019s logs and collapsible sections for build and deploy logs respectively for quick debugging. The second action will make sure that the respective app is deleted when the pull request closes or is merged.<\/p>\n
name<\/span>:<\/span> App Platform Preview\n\non<\/span>:<\/span>\n  pull_request<\/span>:<\/span>\n    branches<\/span>:<\/span> [<\/span>main]<\/span>\n\npermissions<\/span>:<\/span>\n  contents<\/span>:<\/span> read\n  pull-requests<\/span>:<\/span> write\n\njobs<\/span>:<\/span>\n  test<\/span>:<\/span>\n    name<\/span>:<\/span> preview\n    runs-on<\/span>:<\/span> ubuntu-<\/span>latest\n    steps<\/span>:<\/span>\n      -<\/span> name<\/span>:<\/span> Checkout repository\n        uses<\/span>:<\/span> actions\/checkout@v4\n      -<\/span> name<\/span>:<\/span> Deploy the app\n        id<\/span>:<\/span> deploy\n        uses<\/span>:<\/span> digitalocean\/app_action\/deploy@v2\n        with<\/span>:<\/span>\n          deploy_pr_preview<\/span>:<\/span> \"true\"<\/span>\n          token<\/span>:<\/span> ${<\/span>{<\/span> secrets.DIGITALOCEAN_ACCESS_TOKEN }<\/span>}<\/span>\n      -<\/span> uses<\/span>:<\/span> actions\/github-<\/span>script@v7\n        env<\/span>:<\/span>\n          BUILD_LOGS<\/span>:<\/span> ${<\/span>{<\/span> steps.deploy.outputs.build_logs }<\/span>}<\/span>\n          DEPLOY_LOGS<\/span>:<\/span> ${<\/span>{<\/span> steps.deploy.outputs.deploy_logs }<\/span>}<\/span>\n        with<\/span>:<\/span>\n          script<\/span>:<\/span> |<\/span>\n            const { BUILD_LOGS, DEPLOY_LOGS } = process.env\n            github.rest.issues.createComment({\n              issue_number: context.issue.number,\n              owner: context.repo.owner,\n              repo: context.repo.repo,\n              body: `:rocket: :rocket: :rocket: The app was successfully deployed at ${{ fromJson(steps.deploy.outputs.app).live_url }}.`\n            })<\/span>\n      -<\/span> uses<\/span>:<\/span> actions\/github-<\/span>script@v7\n        if<\/span>:<\/span> failure()\n        with<\/span>:<\/span>\n          script<\/span>:<\/span> |<\/span>\n            github.rest.issues.createComment({\n              issue_number: context.issue.number,\n              owner: context.repo.owner,\n              repo: context.repo.repo,\n              body: `The app failed to be deployed. Logs can be found [here](https:\/\/github.com\/${{ github.repository }}\/actions\/runs\/${{ github.run_id }}).<\/span>\n\n              ## Logs<\/span>\n              
>\n              >Build logs<\/summary>>\n              \n              \\`\\`\\`\n              ${<\/span>BUILD_LOGS}<\/span>\n              \\`\\`\\`\n              <\/details>>\n              \n              
>\n              >Deploy logs<\/summary>>\n\n              \\`\\`\\`\n              ${<\/span>DEPLOY_LOGS}<\/span>\n              \\`\\`\\`\n              <\/details>>`\n            }<\/span>)\n<\/code><\/pre>\n
name<\/span>:<\/span> Delete Preview\n\non<\/span>:<\/span>\n  pull_request<\/span>:<\/span>\n    types<\/span>:<\/span> [<\/span> closed ]<\/span>\n\njobs<\/span>:<\/span>\n  closed<\/span>:<\/span>\n    runs-on<\/span>:<\/span> ubuntu-<\/span>latest\n    steps<\/span>:<\/span>\n      -<\/span> name<\/span>:<\/span> delete preview app\n        uses<\/span>:<\/span> digitalocean\/app_action\/delete@v2\n        with<\/span>:<\/span>\n          from_pr_preview<\/span>:<\/span> \"true\"<\/span>\n          ignore_not_found<\/span>:<\/span> \"true\"<\/span>\n          token<\/span>:<\/span> ${<\/span>{<\/span> secrets.DIGITALOCEAN_ACCESS_TOKEN }<\/span>}<\/span>\n<\/code><\/pre>\n

\n
Source link <\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
GitHub Actions is the CI\/CD platform our customers use the most for building and deploying their code. In the past, we\u2019ve provided a supported action, called app_action, that could be used to update an App that already exists via a GitHub Action. Today, we\u2019re excited to introduce completely overhauled GitHub Actions for App Platform with […]<\/p>\n","protected":false},"author":1,"featured_media":9011,"comment_status":"","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"inline_featured_image":false,"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[16],"tags":[],"class_list":["post-9010","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-app-developer"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.satup.xyz\/index.php\/wp-json\/wp\/v2\/posts\/9010","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.satup.xyz\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.satup.xyz\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.satup.xyz\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.satup.xyz\/index.php\/wp-json\/wp\/v2\/comments?post=9010"}],"version-history":[{"count":0,"href":"https:\/\/www.satup.xyz\/index.php\/wp-json\/wp\/v2\/posts\/9010\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.satup.xyz\/index.php\/wp-json\/wp\/v2\/media\/9011"}],"wp:attachment":[{"href":"https:\/\/www.satup.xyz\/index.php\/wp-json\/wp\/v2\/media?parent=9010"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.satup.xyz\/index.php\/wp-json\/wp\/v2\/categories?post=9010"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.satup.xyz\/index.php\/wp-json\/wp\/v2\/tags?post=9010"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
You can find the code and documentation at the app_action GitHub repository<\/a>. We\u2019re excited to see what kind of an integration you can come up with! Give the new actions a try and bring your app platform deployments to the next level.<\/p>\n<\/div>\n