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

Removed forced options, cleaned up link checker args. #4726

Merged
merged 1 commit into from
Aug 9, 2023

Conversation

dblock
Copy link
Member

@dblock dblock commented Aug 9, 2023

Description

It seems like the @check_forced_external option was added to enable checking internal links marked as external e.g. /docs, however the forced external matcher @forced_external_matcher = %r{^https?://.*(?=opensearch\.org/)}.freeze seems to just say "anything on opensearch.org". Jekyll renders all URLs using the base URL, so everything would match that now. I don't think this option is useful in its current state at all.

@AMoo-Miki correct me if I am wrong.

This PR also makes passing arguments a bit easier to read, removing the magical [1..3] check in incremental options in favor of using Ruby::Enum, and renames should_build_fatally to fail_on_error which is more intentional.

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

Thanks, @dblock!

@kolchfa-aws kolchfa-aws merged commit 77d4fb4 into opensearch-project:main Aug 9, 2023
@kolchfa-aws kolchfa-aws added backport 1.3 PR: Backport label for v1.3.x backport 2.0 PR: Backport label for v2.0.x backport 2.1 PR: Backport label for 2.1 backport 2.2 PR: Backport label for 2.2 backport 2.3 PR: Backport label for 2.3 backport 2.5 PR: Backport label for 2.5 backport 2.6 PR: Backport label for 2.6 backport 2.7 PR: Backport label for 2.7 backport 2.8 PR: Backport label for 2.8 backport 2.9 PR: Backport label for 2.9 labels Aug 9, 2023
@opensearch-trigger-bot
Copy link
Contributor

The backport to 1.3 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-1.3 1.3
# Navigate to the new working tree
pushd ../.worktrees/backport-1.3
# Create a new branch
git switch --create backport/backport-4726-to-1.3
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 77d4fb409aa183fe606e99460aad9b1b5d23be1e
# Push it to GitHub
git push --set-upstream origin backport/backport-4726-to-1.3
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-1.3

Then, create a pull request where the base branch is 1.3 and the compare/head branch is backport/backport-4726-to-1.3.

@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.0 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.0 2.0
# Navigate to the new working tree
pushd ../.worktrees/backport-2.0
# Create a new branch
git switch --create backport/backport-4726-to-2.0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 77d4fb409aa183fe606e99460aad9b1b5d23be1e
# Push it to GitHub
git push --set-upstream origin backport/backport-4726-to-2.0
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.0

Then, create a pull request where the base branch is 2.0 and the compare/head branch is backport/backport-4726-to-2.0.

@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.8 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.8 2.8
# Navigate to the new working tree
pushd ../.worktrees/backport-2.8
# Create a new branch
git switch --create backport/backport-4726-to-2.8
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 77d4fb409aa183fe606e99460aad9b1b5d23be1e
# Push it to GitHub
git push --set-upstream origin backport/backport-4726-to-2.8
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.8

Then, create a pull request where the base branch is 2.8 and the compare/head branch is backport/backport-4726-to-2.8.

opensearch-trigger-bot bot pushed a commit that referenced this pull request Aug 9, 2023
Signed-off-by: dblock <[email protected]>
(cherry picked from commit 77d4fb4)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.3 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.3 2.3
# Navigate to the new working tree
pushd ../.worktrees/backport-2.3
# Create a new branch
git switch --create backport/backport-4726-to-2.3
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 77d4fb409aa183fe606e99460aad9b1b5d23be1e
# Push it to GitHub
git push --set-upstream origin backport/backport-4726-to-2.3
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.3

Then, create a pull request where the base branch is 2.3 and the compare/head branch is backport/backport-4726-to-2.3.

@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.2 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.2 2.2
# Navigate to the new working tree
pushd ../.worktrees/backport-2.2
# Create a new branch
git switch --create backport/backport-4726-to-2.2
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 77d4fb409aa183fe606e99460aad9b1b5d23be1e
# Push it to GitHub
git push --set-upstream origin backport/backport-4726-to-2.2
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.2

Then, create a pull request where the base branch is 2.2 and the compare/head branch is backport/backport-4726-to-2.2.

@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.7 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.7 2.7
# Navigate to the new working tree
pushd ../.worktrees/backport-2.7
# Create a new branch
git switch --create backport/backport-4726-to-2.7
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 77d4fb409aa183fe606e99460aad9b1b5d23be1e
# Push it to GitHub
git push --set-upstream origin backport/backport-4726-to-2.7
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.7

Then, create a pull request where the base branch is 2.7 and the compare/head branch is backport/backport-4726-to-2.7.

@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.5 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.5 2.5
# Navigate to the new working tree
pushd ../.worktrees/backport-2.5
# Create a new branch
git switch --create backport/backport-4726-to-2.5
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 77d4fb409aa183fe606e99460aad9b1b5d23be1e
# Push it to GitHub
git push --set-upstream origin backport/backport-4726-to-2.5
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.5

Then, create a pull request where the base branch is 2.5 and the compare/head branch is backport/backport-4726-to-2.5.

@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.6 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.6 2.6
# Navigate to the new working tree
pushd ../.worktrees/backport-2.6
# Create a new branch
git switch --create backport/backport-4726-to-2.6
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 77d4fb409aa183fe606e99460aad9b1b5d23be1e
# Push it to GitHub
git push --set-upstream origin backport/backport-4726-to-2.6
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.6

Then, create a pull request where the base branch is 2.6 and the compare/head branch is backport/backport-4726-to-2.6.

@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.1 failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/backport-2.1 2.1
# Navigate to the new working tree
pushd ../.worktrees/backport-2.1
# Create a new branch
git switch --create backport/backport-4726-to-2.1
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 77d4fb409aa183fe606e99460aad9b1b5d23be1e
# Push it to GitHub
git push --set-upstream origin backport/backport-4726-to-2.1
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/backport-2.1

Then, create a pull request where the base branch is 2.1 and the compare/head branch is backport/backport-4726-to-2.1.

@dblock dblock deleted the remove-forced-options branch August 9, 2023 16:41
@AMoo-Miki
Copy link
Collaborator

AMoo-Miki commented Aug 9, 2023

Forced matcher was meant to treat links to the website and forum as external to the docsite despite them sharing a domain name. The code has changed a lot and I am not sure how something like https://opensearch.org/bad/url is validated now.

@dblock
Copy link
Member Author

dblock commented Aug 9, 2023

Forced matcher was meant to treat links to the website and forum as external to the docsite despite them sharing a domain name. The code has changed a lot and I am not sure how something like https://opensearch.org/bad/url is validated now.

Looks like there are no such links left in this project (or link checker would have failed). If needed we can re-add a list of URLs to ignore, feels simpler.

Naarcha-AWS pushed a commit that referenced this pull request Aug 9, 2023
(cherry picked from commit 77d4fb4)

Signed-off-by: dblock <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
harshavamsi pushed a commit to harshavamsi/documentation-website that referenced this pull request Oct 31, 2023
vagimeli pushed a commit that referenced this pull request Dec 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 1.3 PR: Backport label for v1.3.x backport 2.0 PR: Backport label for v2.0.x backport 2.1 PR: Backport label for 2.1 backport 2.2 PR: Backport label for 2.2 backport 2.3 PR: Backport label for 2.3 backport 2.5 PR: Backport label for 2.5 backport 2.6 PR: Backport label for 2.6 backport 2.7 PR: Backport label for 2.7 backport 2.8 PR: Backport label for 2.8 backport 2.9 PR: Backport label for 2.9
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants