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

doc: update version pattern <cli version>-<year>.<month> #1368

Merged
merged 5 commits into from
Nov 6, 2024

Conversation

erisu
Copy link
Member

@erisu erisu commented Oct 23, 2024

Motivation and Context

Support new versioning pattern for docs.

Description

Updated tooling that updates current released docs and creating new snapshots to support current and new version pattern.

New pattern: <cli version>-<year{4}>.<month{2}>

Example: 12.x-2024.10

Testing

npx gulp newversion

  • Creates new snapshot
  • Updates VERSION file with new current version
  • with --bumpCli flag
    • Confirm new snapshot to contain directory with new pattern 13.x-2024.10
    • Confirm new snapshot to create new toc file with new pattern en_13-x-2024-10-src.yml
  • without --bumpCli flag
    • Confirm new snapshot to contain directory with new pattern 12.x-2024.10
    • Confirm new snapshot to create new toc file with new pattern en_12-x-2024-10-src.yml
  • without --bumpCli flag and snapshot already existed
    • Errors and stops with error message: [ERROR] The targeted docs version "12.x-2024.10" already exist. Are you trying to update the existing snapshot? Use "npm run update-docs".

npm run update-docs

  • Existing version pattern
    • Confirm that 12.x is updated based on version defined in VERSION
  • New version pattern
    • Confirm that 13.x-2024.10 is updated based on version defined in VERSION

Checklist

  • I've run the tests to see all new and existing tests pass
  • I added automated test coverage as appropriate for this change
  • Commit is prefixed with (platform) if this change only applies to one platform (e.g. (android))
  • If this Pull Request resolves an issue, I linked to the issue in the text above (and used the correct keyword to close issues using keywords)
  • I've updated the documentation if necessary

@erisu erisu force-pushed the doc/update-versioning-pattern branch 2 times, most recently from c2ffdc7 to 3e1ea6c Compare October 23, 2024 08:33
@erisu erisu marked this pull request as ready for review October 23, 2024 08:41
@erisu erisu force-pushed the doc/update-versioning-pattern branch from 2325f7b to 14357c4 Compare November 6, 2024 06:34
Copy link
Member

@NiklasMerz NiklasMerz left a comment

Choose a reason for hiding this comment

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

I'm a fan of the new versioning.

@erisu erisu merged commit 4db7637 into apache:master Nov 6, 2024
1 check passed
@erisu erisu deleted the doc/update-versioning-pattern branch November 6, 2024 09:53
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