Skip to content

Conversation

@adoroszlai
Copy link
Contributor

@adoroszlai adoroszlai commented Dec 6, 2024

What changes were proposed in this pull request?

1. edge docs are not updated in the website.

  • HDDS-7678 added workflow for publishing content from hdds-docs to the website.
  • INFRA-25530 changed default branch from asf-site to master, effectively disabling the workflow (scheduled workflows need to be present in the default branch).
  • Cherry-picked the workflow to master as it was added in HDDS-7678.
  • HDDS-11365 introduced ozone-dev-support module, which is not available when building only the docs.

So workflow run fails with:

Failed to execute goal org.apache.maven.plugins:maven-remote-resources-plugin:1.7.0:process (default) on project hdds-docs: Execution default of goal org.apache.maven.plugins:maven-remote-resources-plugin:1.7.0:process failed: Plugin org.apache.maven.plugins:maven-remote-resources-plugin:1.7.0 or one of its dependencies could not be resolved: Could not find artifact org.apache.ozone:ozone-dev-support:jar:2.0.0-SNAPSHOT in apache.snapshots.https (https://repository.apache.org/content/repositories/snapshots)

0c4abe6 fixes this by executing Hugo directly, bypassing Maven.
This is achieved by running the same command as basic (docs) check in Ozone CI.

2. edge docs are updated by the workflow even if no docs were changed.

  • Doc footer includes Last Modified time and commit information.
  • actions/checkout clones the repo without history by default.
  • Hugo only has information about the most recent commit, marking every page as modified by that one.
  • Last Modified information is wrong, and workflow finds "changes" in doc every day.

36f5488 fixes this by cloning apache/ozone with history.

Since both fixes are one-liners, I bundled them in the same PR.

https://issues.apache.org/jira/browse/HDDS-11871

How was this patch tested?

Run 1: https://github.com/adoroszlai/ozone-site/actions/runs/12197628118
Doc update: adoroszlai@88c05d3

  • pick up recent doc additions, e.g. tools/debug
  • update footer with proper last modified information

Run 2: https://github.com/adoroszlai/ozone-site/actions/runs/12197847484
Doc update: none

Your branch is up to date with 'origin/asf-site'.
nothing to commit, working tree clean
Everything up-to-date

@adoroszlai adoroszlai self-assigned this Dec 6, 2024
Copy link

@devabhishekpal devabhishekpal left a comment

Choose a reason for hiding this comment

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

Thanks for the changes @adoroszlai
The changes LGTM +1.

Copy link
Contributor

@errose28 errose28 left a comment

Choose a reason for hiding this comment

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

LGTM good finds @adoroszlai

@errose28 errose28 merged commit e0e1ef9 into apache:master Dec 6, 2024
2 checks passed
@adoroszlai
Copy link
Contributor Author

Thanks @devabhishekpal, @errose28 for the review.

@adoroszlai adoroszlai deleted the HDDS-11871 branch December 7, 2024 04:32
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