Skip to content

feat: Deploy docs only when package is published with a new tag #98

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

Merged
merged 4 commits into from
Apr 19, 2025

Conversation

other-yuka
Copy link
Contributor

Changes

  • Added a Vercel deploy workflow that only updates docs when we create a new tag
  • Turned off Vercel's automatic Git deploys so only our GitHub Actions workflow can update the docs
  • Now docs update at the same time as the package is published

Background

Before, docs would update whenever we merged code to the main branch. this was a problem because people could see the new docs before the package was actually available to use. This change makes sure docs and the package update together.

How to Test

I've already verified this functionality in my personal repository:

  1. Push to main branch: deploy-docs was skipped as expected
    https://github.com/other-yuka/es-git/actions/runs/14342063510
  2. Push a new tag: deploy-docs workflow executed successfully
    https://github.com/other-yuka/es-git/actions/runs/14342126756

Important Setup Required

for this workflow to run properly, the following secret keys must be added to the repository:

  • VERCEL_ORG_ID
  • VERCEL_PROJECT_ID
  • VERCEL_TOKEN

Closes #90

Enables automatic deployment of the documentation to Vercel upon tag creation.
Additionally, it disables git deployment on Vercel to rely solely on the workflow.
@other-yuka other-yuka requested a review from seokju-na as a code owner April 16, 2025 12:48
Copy link
Collaborator

@seokju-na seokju-na left a comment

Choose a reason for hiding this comment

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

Added secret to github actions. Thanks a lot!

@seokju-na seokju-na merged commit c9bdb8e into toss:main Apr 19, 2025
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deploy documentation when package published
2 participants