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.

Sign up for GitHub

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

feat: preview label deployments #1413

Merged
merged 2 commits into from
Jan 2, 2025
Merged

feat: preview label deployments #1413

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
71b1d53
preview label deployments
codemonkey800 Dec 19, 2024
4272c57
remove unnecessary condition
codemonkey800 Dec 24, 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
159 changes: 139 additions & 20 deletions .github/workflows/dev-deploy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,36 +7,79 @@ on:
delete:
branches:
- 'dev-*'
pull_request:
types: [labeled, unlabeled, synchronize, closed]

# https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services
permissions:
id-token: write
contents: read
id-token: write
pull-requests: write

jobs:
deploy-to-dev:
name: deploy dev branch
runs-on: ubuntu-latest
environment: dev
if: github.repository == 'chanzuckerberg/cryoet-data-portal'
if: |
github.repository == 'chanzuckerberg/cryoet-data-portal' && (
codemonkey800 marked this conversation as resolved.
Show resolved Hide resolved
github.event_name != 'pull_request' || (
startsWith(github.head_ref, 'dev-') != true && (
contains(github.event.pull_request.labels.*.name, 'preview') || (
github.event.action == 'unlabeled' &&
github.event.label.name == 'preview'
)
)
)
)

steps:
- name: Checkout Repo
uses: actions/checkout@v4

- id: deploy-data
name: get stack name
uses: actions/github-script@v7
with:
result-encoding: string
script: |
const event = ${{ toJson(github.event) }}
const eventName = '${{ github.event_name }}'

let name = ''
Copy link
Contributor

Choose a reason for hiding this comment

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

is this necessary? does using the branch name not work?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

let me check, I think it's because the ref is different depending on the event but maybe we can use event.ref for both 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

actually yeah this is required, we can only get the ref name for the PR from the pull request event object. using something like github.ref will only return the PR number:

https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/accessing-contextual-information-about-workflow-runs#github-context

image

I did a test run here and you can see it doesn't include the ref name in the last value. instead, it shows up as 1428/merge:

https://github.com/chanzuckerberg/cryoet-data-portal/actions/runs/12481761093/job/34834780913?pr=1428


switch (eventName) {
case 'pull_request': {
name = event.pull_request.head.ref
break
}

default: {
name = event.ref.replace('refs/heads/', '')
break
}
}

return name.replaceAll('/', '-').slice(0, 25)

- name: Configure AWS Credentials
uses: aws-actions/configure-aws-credentials@v4
with:
mask-aws-account-id: true
aws-region: ${{ secrets.AWS_REGION }}
role-to-assume: ${{ secrets.AWS_ROLE_TO_ASSUME }}
role-duration-seconds: 1200
- name: Setting up stack name
run: |
if [[ ${#GITHUB_REF_NAME} -gt 25 ]]; then
echo "branch name: ${GITHUB_REF_NAME}, length ${#GITHUB_REF_NAME}, is $((${#GITHUB_REF_NAME} - 25)) characters too long, please use a branch name that's 25 characters or shorter"
exit 1
else
echo $GITHUB_REF_NAME | tr '[:upper:]' '[:lower:]' | xargs -I {} -n 1 echo STACK_NAME={} >> $GITHUB_ENV
fi

- name: Create or update dev stack
if: ${{ github.event_name == 'push' }}
if: |
github.event_name == 'push' || (
github.event_name == 'pull_request' && (
github.event.action == 'labeled' || (
github.event.action == 'synchronize' &&
contains(github.event.pull_request.labels.*.name, 'preview')
Copy link
Contributor

Choose a reason for hiding this comment

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

is this the only thing you need to check? this whole condition only has to be a subset of the condition at the job level right?

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 think the main thing is we only want this to run when:

  1. it's a push to dev-*
  2. the PR is labeled
  3. the PR is updated

we actually do check if preview exists before executing the job here:

https://github.com/chanzuckerberg/cryoet-data-portal/pull/1413/files/71b1d537f6ebcb5b719ba03e31df4580116f8d82#diff-e7d952112309f847816123cb3297f8db4d225d21505ac9a474488114ce6bb83dR28

so maybe we can remove this since it's already checked. if the event is synchronize, then it should have the preview label since the above condition passed 🤣

let me check and see if it works as expected without this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

just checked, yeah this can be removed. thank you for catching this!! 🔥

)
)
)
uses: chanzuckerberg/github-actions/.github/actions/[email protected]
env:
# Force using BuildKit instead of normal Docker, required so that metadata
Expand All @@ -46,31 +89,107 @@ jobs:
DOCKER_REPO: ${{ secrets.ECR_REPO }}/
ENV: dev
with:
stack-name: ${{ env.STACK_NAME }}
stack-name: ${{ steps.deploy-data.outputs.result }}
create-tag: true
tfe-token: ${{ secrets.TFE_TOKEN }}
working-directory: ./frontend
env: dev
operation: create-or-update

- name: Annotate workflow run with frontend URL
if: ${{ github.event_name == 'push' }} && success()
if: |
github.event_name == 'push' || (
github.event_name == 'pull_request' && (
github.event.action == 'labeled' || (
github.event.action == 'synchronize' &&
contains(github.event.pull_request.labels.*.name, 'preview')
)
)
)
run: |
echo "# Frontend URL:" >> $GITHUB_STEP_SUMMARY
echo >> $GITHUB_STEP_SUMMARY
echo "https://${{ env.STACK_NAME }}.cryoet.dev.si.czi.technology" >> $GITHUB_STEP_SUMMARY
echo "https://${{ steps.deploy-data.outputs.result }}.cryoet.dev.si.czi.technology" >> $GITHUB_STEP_SUMMARY

- id: find-comment
name: Find PR comment
if: github.event_name == 'pull_request'
uses: peter-evans/find-comment@v3
with:
issue-number: ${{ github.event.pull_request.number }}
body-includes: 'Frontend Preview URL'

- id: get-comment-date
name: Get PR comment updated date
if: github.event_name == 'pull_request'
uses: actions/github-script@v7
with:
result-encoding: string
script: |
const date = new Date()

const options = {
month: '2-digit',
day: '2-digit',
year: '2-digit',
hour: '2-digit',
minute: '2-digit',
second: '2-digit',
hour12: true,
};

const pstDate = date.toLocaleString('en-US', { timeZone: 'America/Los_Angeles', ...options });
return pstDate.replace(',', ' @');

- name: Post comment on PR
if: |
github.event_name == 'pull_request' && (
github.event.action == 'labeled' ||
github.event.action == 'synchronize'
)
uses: peter-evans/create-or-update-comment@v4
with:
comment-id: ${{ steps.find-comment.outputs.comment-id}}
issue-number: ${{ github.event.pull_request.number}}
edit-mode: replace
body: |
# Frontend Preview URL

https://${{ steps.deploy-data.outputs.result }}.cryoet.dev.si.czi.technology

Updated: ${{ steps.get-comment-date.outputs.result }} PST
Copy link
Contributor

Choose a reason for hiding this comment

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

Fancy!


- name: Delete PR comment
if: |
github.event_name == 'pull_request' && (
github.event.action == 'unlabeled' ||
github.event.action == 'closed'
) &&
steps.find-comment.outputs.comment-id != ''
uses: actions/github-script@v7
with:
script: |
github.rest.issues.deleteComment({
comment_id: ${{ steps.find-comment.outputs.comment-id }},
owner: context.repo.owner,
repo: context.repo.repo,
})

- name: Delete dev set up stack name
if: ${{ github.event_name == 'delete' && startsWith(github.event.ref, 'dev-') }}
run: |
echo ${{ github.event.ref }} | tr '[:upper:]' '[:lower:]' | xargs -I {} -n 1 echo DELETE_STACK_NAME={} >> $GITHUB_ENV
- name: Delete dev
if: ${{ github.event_name == 'delete' && startsWith(github.event.ref, 'dev-') }}
if: |
github.event_name == 'delete' || (
github.event_name == 'pull_request' && (
github.event.action == 'unlabeled' || (
github.event.action == 'closed' &&
contains(github.event.pull_request.labels.*.name, 'preview')
)
)
)
uses: chanzuckerberg/github-actions/.github/actions/[email protected]
env:
ENV: dev
with:
stack-name: ${{ env.DELETE_STACK_NAME }}
stack-name: ${{ steps.deploy-data.outputs.result }}
operation: delete
tfe-token: ${{ secrets.TFE_TOKEN }}
env: dev
Expand Down
Loading