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

fix(docs): ensure alias is applied to versioned releases #2644

Merged
merged 1 commit into from
Jul 4, 2023

Conversation

sthulb
Copy link
Contributor

@sthulb sthulb commented Jul 4, 2023

Issue number: #2628

Summary

Changes

Please provide a summary of what's being changed

Ensures that the JQ voodoo inserts the alias.

User experience

Please share what the user experience looks like before and after this change

Before:
Alias wasn't inserted into the versions.json unless it was a new version number,

After:
alias is added to the targeted version number or new version number

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Is this a breaking change?

RFC issue number:

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

Acknowledgment

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.

Signed-off-by: Simon Thulbourn <sthulb@users.noreply.github.com>
@sthulb sthulb requested a review from a team July 4, 2023 13:29
@boring-cyborg boring-cyborg bot added the github-actions Pull requests that update Github_actions code label Jul 4, 2023
@pull-request-size pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jul 4, 2023
@heitorlessa
Copy link
Contributor

looking...👀 as on-call is busy with Pydantic v2

@github-actions github-actions bot added bug Something isn't working labels Jul 4, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jul 4, 2023

No related issues found. Please ensure there is an open issue related to this change to avoid significant delays or closure.

@github-actions github-actions bot added do-not-merge need-issue PRs that are missing related issues labels Jul 4, 2023
@heitorlessa heitorlessa removed do-not-merge need-issue PRs that are missing related issues labels Jul 4, 2023
@sthulb
Copy link
Contributor Author

sthulb commented Jul 4, 2023

input file:

[
  {
    "title": "2.19.0",
    "version": "2.19.0",
    "aliases": []
  },
  {
    "title": "2.18.0",
    "version": "2.18.0",
    "aliases": []
  }
]

output with same version number:

[
  {
    "title": "2.19.0",
    "version": "2.19.0",
    "aliases": [
      "latest"
    ]
  },
  {
    "title": "2.18.0",
    "version": "2.18.0",
    "aliases": []
  }
]

output with new version number:

[
  {
    "title": "2.20.0",
    "version": "2.20.0",
    "aliases": [
      "latest"
    ]
  },
  {
    "title": "2.19.0",
    "version": "2.19.0",
    "aliases": []
  },
  {
    "title": "2.18.0",
    "version": "2.18.0",
    "aliases": []
  }
]

@heitorlessa heitorlessa merged commit 783e242 into develop Jul 4, 2023
@heitorlessa heitorlessa deleted the docs-version-json branch July 4, 2023 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working github-actions Pull requests that update Github_actions code size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants