Skip to content

Commit

Permalink
[CHORE] Adding env var to trigger docs deploy manually from Buildkite…
Browse files Browse the repository at this point in the history
… UI (#7397)
  • Loading branch information
1Copenut authored Dec 6, 2023
1 parent 5090391 commit a6eb185
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 3 deletions.
10 changes: 8 additions & 2 deletions scripts/deploy/deploy_docs
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ post_comment_to_gh()
curl -s -L "https://api.github.com/repos/elastic/eui/issues/${GIT_PULL_REQUEST_ID}/comments" \
| jq -c '.[] | select(.user.login == "kibanamachine") | .id' \
)
for comment_id in ${kibanamachine_comment_ids[@]}; do
for comment_id in "${kibanamachine_comment_ids[@]}"; do
curl -L \
-X DELETE \
-H "Authorization: token ${GITHUB_TOKEN}" \
Expand Down Expand Up @@ -150,7 +150,13 @@ else
publish_to_bucket
fi

# Let users know neither job ran
# Manually deploy latest docs via Buildkite UI
elif [[ "${DEPLOY_ROOT}" == "true" ]]; then
echo "Maually deploying latest release. Deploying to root eui.elastic.co"
full_bucket_path="gs://${BUCKET}/"
publish_to_bucket

# Let users know none of the three jobs ran
else
echo "This is neither a pull request nor a tag release. No docs were deployed."
fi
Expand Down
12 changes: 11 additions & 1 deletion wiki/eui-team-processes/releasing-versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ npm whoami # Should return an error about not being logged in

Buildkite automatically deploys our docs to the EUI `Bekitzur` environment. The Buildkite job is started when a new tag is pushed to the `main` branch.

To view the progress of your job or check for errors:
**To view the progress of your job or check for errors:**

* Log in to Buildkite using Elastic SSO
* Filter jobs by `eui-team`
Expand All @@ -50,6 +50,16 @@ To view the progress of your job or check for errors:
* Click the `Rebuild` button if your job needs to be restarted **or**
* Click the `.buildkite/scripts/pipelines/pipeline_deploy_docs.sh` row to view logs and environment details

**To deploy release docs manually:**

* Log in to Buildkite using Elastic SSO
* Filter jobs by `eui-team`
* Click on `eui-release-deploy-docs`
* Click the green `New Build` button on the top right
* Click the `Options` accordion to show the Environment Variables textbox
* Add `DEPLOY_ROOT=true` to the Environment Variables textbox
* Click `Create Build` to start the job manually

### Tag the release in GitHub

We also update the [release's tag in github](https://github.com/elastic/eui/tags) by _creating a release_ for the version and copying over its _CHANGELOG_ entries.
Expand Down

0 comments on commit a6eb185

Please sign in to comment.