Skip to content

Conversation

@jackkoenig
Copy link
Contributor

I've also asked webcrawlers not to index the snapshot API docs, although they still will if elsewhere on the internet links to them.

Contributor Checklist

  • Did you add Scaladoc to every public function/method?
  • Did you add at least one test demonstrating the PR?
  • Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • Did you add appropriate documentation in docs/src?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • Documentation or website-related

Desired Merge Strategy

  • Squash

Release Notes

Previously, we linked to s01.sonatype which allowed rendering doc jars in the browser. As Sonatype has been sunset and Maven Central does not appear to support this, we will have to host the latest snapshot ourselves.

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels? (Select the most appropriate one based on the "Type of Improvement")
  • Did you mark the proper milestone (Bug fix: 3.6.x, 5.x, or 6.x depending on impact, API modification or big change: 7.0)?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you do one of the following when ready to merge:
    • Squash: You/ the contributor Enable auto-merge (squash) and clean up the commit message.
    • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

Previously, we linked to s01.sonatype which allowed rendering doc jars
in the browser. As Sonatype has been sunset and Maven Central does not
appear to support this, we will have to host the latest snapshot
ourselves.
@jackkoenig jackkoenig added the Documentation Only changing documentation label Oct 28, 2025
Copy link
Member

@seldridge seldridge left a comment

Choose a reason for hiding this comment

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

Generally looks good. Apologies for making you write make.

$(snapshot_scaladoc_dir)/index.html: $(snapshot_scaladoc_jar) | $(snapshot_scaladoc_dir)
rm -rf $(snapshot_scaladoc_dir)/*
cd $(snapshot_scaladoc_dir) && unzip -q $<
touch $@
Copy link
Member

Choose a reason for hiding this comment

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

I thought this was unnecessary, but if the timestamp comes from the archive, then it is necessary. Nice catch.

@jackkoenig
Copy link
Contributor Author

Generally looks good. Apologies for making you write make.

Sometime when I'm bored I'll try out moving the logic to mill and see if its better or worse... it'll almost certainly at least be easier to write code that tracks dependencies properly since I (like most people) am trash at Make.

@jackkoenig jackkoenig enabled auto-merge (squash) October 28, 2025 22:42
@jackkoenig jackkoenig merged commit 74f04bf into main Oct 28, 2025
19 checks passed
@jackkoenig jackkoenig deleted the jackkoenig/snapshot-api branch October 28, 2025 23:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Only changing documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants