Skip to content

chore(ci): add version number normalization to docs publishing #1433

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 1 commit into from
May 4, 2023

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

As described in the linked issue, the docs publishing workflow was creating version numbers that contained a v prefix, which is not in line with the rest of the versions used across docs.

This PR introduces an additional step to the reusable-publish-docs workflow to normalize the version number and remove the prefix when previous. This way docs will always be published under the correct version/convention.

Once merged this issue closes #1421.

Related issues, RFCs

Issue number: #1421

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding changes to the examples
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • Any dependent changes have been merged and published
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@dreamorosi dreamorosi self-assigned this May 4, 2023
@dreamorosi dreamorosi linked an issue May 4, 2023 that may be closed by this pull request
2 tasks
@pull-request-size pull-request-size bot added the size/XS PR between 0-9 LOC label May 4, 2023
@dreamorosi dreamorosi changed the title chore(ci): add versionn number normalization to docs publishing chore(ci): add version number normalization to docs publishing May 4, 2023
@github-actions github-actions bot added the internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) label May 4, 2023
@dreamorosi dreamorosi merged commit 160f539 into main May 4, 2023
@dreamorosi dreamorosi deleted the 1421-maintenance-docs-versioning-labels branch May 4, 2023 09:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) size/XS PR between 0-9 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenance: docs versioning & labels
1 participant