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.

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

docs: update Docker Compose setup guide to checkout latest tag #4695

Merged
merged 2 commits into from
May 20, 2024

Conversation

SanchithHegde
Copy link
Member

Type of Change

  • Bugfix
  • New feature
  • Enhancement
  • Refactoring
  • Dependency updates
  • Documentation
  • CI/CD

Description

This PR updates the release stable version workflow with a new step to update the latest tag to the newly created SemVer tag, and updates the Docker Compose setup guide to checkout the latest tag when cloning the repository.

Motivation and Context

This would help prevent failures with starting the app server when running off of the main branch, specifically when a new enum variant has been introduced in the main branch, but is not available in the latest stable release. Checking out the latest stable release when running the Docker Compose setup would ensure that a compatible configuration file would be used, and thus reduce server startup failures.

How did you test it?

I've tested out the new step added in the stable release workflow by running the command locally, first by creating the latest tag manually to point to an old release, then by running the command to point to the latest stable release.

Checklist

  • I formatted the code cargo +nightly fmt --all
  • I addressed lints thrown by cargo clippy
  • I reviewed the submitted code
  • I added unit tests for my changes where possible

@SanchithHegde SanchithHegde added A-CI-CD Area: Continuous Integration/Deployment A-infra Area: Infrastructure C-doc Category: Documentation updates S-waiting-on-review Status: This PR has been implemented and needs to be reviewed labels May 19, 2024
@SanchithHegde SanchithHegde self-assigned this May 19, 2024
@SanchithHegde SanchithHegde requested review from a team as code owners May 19, 2024 12:38
@SanchithHegde SanchithHegde added this to the May 2024 Release milestone May 19, 2024
@Gnanasundari24 Gnanasundari24 added this pull request to the merge queue May 20, 2024
Merged via the queue into main with commit 40f6776 May 20, 2024
10 checks passed
@Gnanasundari24 Gnanasundari24 deleted the docs-docker-compose-checkout-latest-tag branch May 20, 2024 13:15
@SanchithHegde SanchithHegde removed the S-waiting-on-review Status: This PR has been implemented and needs to be reviewed label May 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-CI-CD Area: Continuous Integration/Deployment A-infra Area: Infrastructure C-doc Category: Documentation updates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants