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.

Sign up for GitHub

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

Add extra link check to release.md #613

Closed
wants to merge 2 commits into from
Closed

Add extra link check to release.md #613

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
acd9d22
Add extra link check to release.md
lmolkova Dec 17, 2024
84b7bfa
Update RELEASING.md
lmolkova Dec 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

_Instruction for Maintainers only._

- Run [opentelemetry.io workflow](https://github.com/open-telemetry/opentelemetry.io/actions/workflows/build-dev.yml)
Copy link
Member

Choose a reason for hiding this comment

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

How do you run this against a submodule? Can you please provide more details. I don't know how to do this.

Copy link
Contributor Author

@lmolkova lmolkova Dec 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

  1. open that link
  2. type opentelemetry-proto into the submodule field
    image
  3. Run it
  4. wait for it to complete
  5. Both BUILD and CHECK LINKS and WARNINGS in build log? should pass.
  6. If any of them fails, check BUILD and CHECK LINKS/Run npm run log:test-and-fix logs - broken links should be there
  7. Ignore REFCACHE updates? status.

Did I capture it right @chalin ?

run with broken links

image

run without issues:

image

I don't think we normally go into this level of details in release doc so I don't think we should update it, it's easy to figure out the moment you try it.

Copy link
Contributor

@chalin chalin Dec 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Yes, that's about it. 👍🏻

Copy link
Member

Choose a reason for hiding this comment

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

Great, thanks! Would it be possible to add the distilled version of this to RELEASING.md?

lmolkova marked this conversation as resolved.
Show resolved Hide resolved
against `opentelemetry-proto` submodule as a smoke-test for docs. Fix broken links, if any.

- Prepare the release by updating [CHANGELOG.md](CHANGELOG.md), see for example
[this PR](https://github.com/open-telemetry/opentelemetry-proto/pull/537).
Merge the PR. From this point on no new PRs can be merged until the release is complete.
Expand Down
Loading