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

chore: update command generator for versioned docs #335

Merged

Conversation

TerryHowe
Copy link
Member

@TerryHowe TerryHowe commented Jun 5, 2024

Created a mapping file in case we need to use a bug fix release to generate the docs. I don't think that will happen often.

Copy link
Member

@FeynmanZhou FeynmanZhou left a comment

Choose a reason for hiding this comment

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

Please see my comments above

@TerryHowe TerryHowe force-pushed the fix-replace-script-for-versions branch from acd359f to 15a77ab Compare June 6, 2024 21:49
@TerryHowe
Copy link
Member Author

@FeynmanZhou I removed the bug fix release from the script and added a way to map using bug fixes if necessary. Normally, the pages won't change during a release.

@TerryHowe TerryHowe changed the title chore: update commands for versioned docs chore: update command generator for versioned docs Jun 7, 2024
Copy link
Contributor

@qweeah qweeah left a comment

Choose a reason for hiding this comment

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

LGTM although IANAM. What if we are updating 1.1 and the content of version-latest is 2.1.1?

Better add some comments or documents on how versions-latest should be used, otherwise when someone need to refresh for a patch release, they need to read and understand below code in refresh-commands.sh

map_version() {
    grep "$1" versions-latest || echo "$1.0"
}

@TerryHowe TerryHowe force-pushed the fix-replace-script-for-versions branch from 15a77ab to dc74774 Compare June 19, 2024 12:35
@qweeah
Copy link
Contributor

qweeah commented Jun 19, 2024

LGTM although IANAM.

Copy link
Member

@FeynmanZhou FeynmanZhou left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks @TerryHowe

@TerryHowe TerryHowe merged commit 4e0e0dd into oras-project:main Jun 20, 2024
6 checks passed
TerryHowe pushed a commit to TerryHowe/oras-www that referenced this pull request Jul 21, 2024
Created a mapping file in case we need to use a bug fix release to
generate the docs. I don't think that will happen often.

Signed-off-by: Terry Howe <[email protected]>
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