Skip to content

Port Documentation/PackageRegistry directory contents into DocC #8745

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

Open
wants to merge 26 commits into
base: main
Choose a base branch
from

Conversation

bripeticca
Copy link
Contributor

@bripeticca bripeticca commented May 29, 2025

Fixes #8596 and fixes #8597.

- Added more descriptions to the subcommands for registry
- Refactored links that were navigating to the proposal for
  registry and instead link them to the subcommands in our
  DocC catalog
@bripeticca
Copy link
Contributor Author

@swift-ci please test

Copy link
Member

@heckj heckj left a comment

Choose a reason for hiding this comment

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

Lots of wording changes - the vast majority of which are:

  • reframing from passive voice to active voice
  • replacing latin abbreviations
  • changing the capitalization of "Package manager" to "package manger" and sometimes adding "the" in front to make it read smoothly.

@bripeticca bripeticca requested a review from heckj June 11, 2025 16:01
@bripeticca
Copy link
Contributor Author

@swift-ci please test

@bripeticca
Copy link
Contributor Author

@swift-ci please test

@bripeticca
Copy link
Contributor Author

@swift-ci please test windows

Copy link
Member

@heckj heckj left a comment

Choose a reason for hiding this comment

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

one little nit early on for making it read a bit more easily, but looks great!

Comment on lines 8 to 11
Author a package collection as a static JSON document and publish it to the web or distribute it on a local file system.

Educators and community influencers can publish package collections to go along with course materials or blog posts, making it easier for their readers to use packages for the first time, or choosing which packages to use for a particular task.
Enterprises may use collections to provide a trusted set of packages, or a collection of packages consistently used by a team.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Author a package collection as a static JSON document and publish it to the web or distribute it on a local file system.
Educators and community influencers can publish package collections to go along with course materials or blog posts, making it easier for their readers to use packages for the first time, or choosing which packages to use for a particular task.
Enterprises may use collections to provide a trusted set of packages, or a collection of packages consistently used by a team.
Educators and community influencers can publish package collections to go along with course materials or blog posts, making it easier for their readers to use packages for the first time, or choosing which packages to use for a particular task.
Enterprises may use collections to provide a trusted set of packages, or a collection of packages consistently used by a team.
Author a package collection as a static JSON document and publish it to the web or distribute it on a local file system.

What do you think of this as one paragraph? I think the "author this by..." stuff may read a little better after we've described the two use cases.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it reads a lot better this way! I'll upload a change for this :)

heckj and others added 9 commits June 16, 2025 21:13
Migrate, and break up, content from `documentation/plugins.md` into DocC
articles.

resolves swiftlang#8592

With the branch checked out, you can use the command:

```bash
swift package --disable-sandbox preview-documentation --target PackageManagerDocs
```

To build and display the collected documentation for easier reviewing.

---------

Co-authored-by: Bri Peticca <[email protected]>
Command plugins should use the user specified build system when building
any dependencies, and if the command plugin requests a build of its own.
Supporting the full range of command plugin functionality with the Swift
Build backend will take a little more work, but this patch gets the
fundamentals wired up
We should avoid adding a dependency on Swift Tools Support Core in
SwiftPM.  If we need to, we ought to use the `swiftTSCBasicsDeps` and
`swiftToolsCoreSupportAutoDeps` variables.
### Motivation:

I hope that this should fix
swiftlang#8731, and make
it easier to build with libFuzzer.

### Modifications:

Add support for a `-sanitize=fuzzer` option in `swift-build`, that sets
the correct flags (including `-parse-as-library`) to build a binary for
fuzzing. Add an additional test to make sure that these flags get set.
…ature flags

The build system requested by the `swift package migrate` command is
transitory and shouldn't be persisted. This would also make sure that
the build plan is always available regardless of what builds happened
before `swift package migrate` invocation.

Resolves: rdar://152687084
It's currently impossible to distringuish between modules that
are created from the declarations in a manifest and the ones
synthesized as part of module graph building and/or build plan
creation. This was only a problem for `SystemLibraryModule` before,
but with the introduction of `swift package migrate` command the
situation changed because the command can only operate on modules
that appear in the manifest file because it won't be possible to
update code or settings of the synthesized modules.
Fixes and setting updates to such modules cannot be applied.

Resolves: rdar://152689053
@bripeticca
Copy link
Contributor Author

@swift-ci please test

@bripeticca
Copy link
Contributor Author

@swift-ci please test windows

@bripeticca
Copy link
Contributor Author

@swift-ci please test macOS

@bripeticca
Copy link
Contributor Author

@swift-ci please test

@bripeticca
Copy link
Contributor Author

@swift-ci please test windows

1 similar comment
@bripeticca
Copy link
Contributor Author

@swift-ci please test windows

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Migrate documentation for Package Registry Server Specification to DocC Migrate documentation for Package Registry Usage to DocC
6 participants