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

Bump github.com/apple/swift-docc-plugin from 1.3.0 to 1.4.1 #68

Merged

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Aug 26, 2024

Bumps github.com/apple/swift-docc-plugin from 1.3.0 to 1.4.1.

Release notes

Sourced from github.com/apple/swift-docc-plugin's releases.

Swift-DocC-Plugin 1.4.1

What's changed

This fixes a build failure with Swift versions before 6.0.

Swift-DocC-Plugin 1.4.0

What's Changed

  • You can now customize the minimal access level of symbols to include in your documentation. The default access level continues to be "public" for libraries and "internal" for executables. To specify a custom minimal access level, pass the new --symbol-graph-minimum-access-level flag:

    swift package generate documentation \
      --symbol-graph-minimum-access-level internal \
      --target [target-name]
    
  • You can now generate a combined documentation archive with the documentation for multiple targets when building with Swift 6.0 or later. Each target's documentation can link to its target dependencies' documentation. This is an opt-in, experimental feature that can used by passing the --enable-experimental-combined-documentation flag:

    swift package generate documentation \
      --enable-experimental-combined-documentation \
      --target [first-target-name] \
      --target [second-target-name] \
    
  • Using a custom --output-path when building documentation for more than one target no longer causes one target to write over the output of the other target. Instead, both targets write their output in subdirectories of the specified output path. When building documentation for a single target, or when building combined documentation, the plugin continues to write the output directly to the specified output path.

  • The help text in swift package generate-documentation --help now includes information about all the DocC options. The help text also organizes the symbol graph options into its own section.


The 1.4.0 release includes contributions from @​natikgadzhi, @​d-ronnqvist, @​JessyCatterwaul, @​joey-gm, @​dabrahams, @​parispittman, @​SwiftCoderJoe, and @​Kyle-Ye. Thank you!

Commits
  • 0510d91 Avoid using NSLock.withLock because Linux doesn't support it before Swift 6...
  • a255bbd Support --output-path when building documentation for multiple targets. (#89)
  • c807246 Simplify argument parsing and processing in the plugin (#88)
  • 6c596f1 Disable integration tests that fail because of rdar://134406349 (#90)
  • 3314a6b [test only] Improve filesIn test-helper function (#87)
  • d80a059 Add symbolGraphMinimumAccessLevel option support (#82)
  • 63f47d3 Add initial experimental support for combined documentation for multiple targ...
  • 5761ba9 Change links to new location (#86)
  • 8950edf Delete CODE_OF_CONDUCT.md (#85)
  • 5fc3645 Suppress warnings on Windows too (#67)
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Bumps [github.com/apple/swift-docc-plugin](https://github.com/apple/swift-docc-plugin) from 1.3.0 to 1.4.1.
- [Release notes](https://github.com/apple/swift-docc-plugin/releases)
- [Commits](swiftlang/swift-docc-plugin@1.3.0...1.4.1)

---
updated-dependencies:
- dependency-name: github.com/apple/swift-docc-plugin
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot requested a review from ffried as a code owner August 26, 2024 05:10
@dependabot dependabot bot added dependencies Pull requests that update a dependency file swift_package_manager Pull requests that update Swift_package_manager code labels Aug 26, 2024
Copy link

codecov bot commented Aug 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 47.71%. Comparing base (3bde61d) to head (78075de).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #68   +/-   ##
=======================================
  Coverage   47.71%   47.71%           
=======================================
  Files           5        5           
  Lines         153      153           
  Branches       26       26           
=======================================
  Hits           73       73           
  Misses         66       66           
  Partials       14       14           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ffried ffried enabled auto-merge (rebase) August 26, 2024 07:52
@ffried ffried merged commit feddca7 into main Aug 26, 2024
17 of 18 checks passed
@ffried ffried deleted the dependabot/swift/github.com/apple/swift-docc-plugin-1.4.1 branch August 26, 2024 07:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file swift_package_manager Pull requests that update Swift_package_manager code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant