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

build(docs): update deploy workflow to trigger when a Release is published #70

Conversation

asdolo
Copy link
Collaborator

@asdolo asdolo commented Sep 11, 2024

What does this do?

Update Docs deploy workflow to trigger when a Release is published.

Why did you do this?

  • The current workflow runs every time a merge to master is done.
  • In real life, there are some cases where we can have changes in master, but we didn’t release a new Template version yet. For instance, if we are merging small PRs which are part of a big feature.
  • In those cases, even if we didn’t release a new version of the template, we are still deploying a new version of the docs.
  • This behaviour isn’t 100% accurate: The deployed documentation could have references to code or features that aren’t yet deployed to the latest version of the Template.

Who/what does this impact?

It affects the documentation deployment process. It also impacts people reading the documentation, who will now be reading the version corresponding to the latest version of the template.

How did you test this?

WIP

Copy link

💯 Test Coverage

Lines Statements Branches Functions
Coverage: 51%
50.6% (253/500) 46.63% (104/223) 36.12% (69/191)

😎 Tests Results

Tests Skipped Failures Errors Time
68 0 💤 0 ❌ 0 🔥 28.478s ⏱️
👀 Tests Details • (51%)
File% Stmts% Branch% Funcs% LinesUncovered Line #s
All files50.646.6336.1251.57 
report-only-changed-files is enabled. No files were changed in this commit :)

Copy link

@guillermomachado guillermomachado left a comment

Choose a reason for hiding this comment

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

Makes sense

@asdolo asdolo enabled auto-merge September 11, 2024 16:56
@asdolo asdolo self-assigned this Sep 11, 2024
@asdolo asdolo merged commit 64ac34b into master Sep 11, 2024
7 checks passed
@asdolo asdolo deleted the build/docs_update_deployworkflow_to_trigger_when_a_release_is_published branch September 11, 2024 18:40
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.

3 participants