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

docs: update quickstart guide to include swift package manager command #1128

Merged
merged 4 commits into from
Jun 27, 2024

Conversation

adincebic
Copy link
Contributor

@adincebic adincebic commented Jun 27, 2024

I noticed that quickstart guide does not mention that users need to run swift package resolveprior to running bazel mod tidy.

Signed-off-by: Adin Cebic <cebic.ad@gmail.com>
@cgrindel
Copy link
Owner

@adincebic Thanks for the PR. Can you run bazel run //:tidy on the repo? It will update the markdown TOC and ensure everything is up-to-date.

@cgrindel cgrindel changed the title Update quickstart guide to include swift package manager command doc: update quickstart guide to include swift package manager command Jun 27, 2024
README.md Outdated Show resolved Hide resolved
@cgrindel cgrindel changed the title doc: update quickstart guide to include swift package manager command docs: update quickstart guide to include swift package manager command Jun 27, 2024
Signed-off-by: Adin Cebic <cebic.ad@gmail.com>
@adincebic
Copy link
Contributor Author

@adincebic Thanks for the PR. Can you run bazel run //:tidy on the repo? It will update the markdown TOC and ensure everything is up-to-date.

Done.

@cgrindel cgrindel enabled auto-merge (squash) June 27, 2024 18:51
@cgrindel cgrindel disabled auto-merge June 27, 2024 23:14
@cgrindel cgrindel merged commit d475395 into cgrindel:main Jun 27, 2024
30 of 32 checks passed
renovate bot referenced this pull request in bazel-contrib/rules_bazel_integration_test Jul 11, 2024
…#344)

[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| rules_swift_package_manager | bazel_dep | minor | `0.34.1` -> `0.35.1`
|
|
[rules_swift_package_manager](https://togithub.com/cgrindel/rules_swift_package_manager)
| http_archive | minor | `v0.34.1` -> `v0.35.1` |

---

### Release Notes

<details>
<summary>cgrindel/rules_swift_package_manager
(rules_swift_package_manager)</summary>

###
[`v0.35.1`](https://togithub.com/cgrindel/rules_swift_package_manager/releases/tag/v0.35.1)

[Compare
Source](https://togithub.com/cgrindel/rules_swift_package_manager/compare/v0.35.0...v0.35.1)

#### What's Changed

- fix: sync Bazel version with BCR presubmit by
[@&#8203;cgrindel](https://togithub.com/cgrindel) in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1163](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1163)

**Full Changelog**:
cgrindel/rules_swift_package_manager@v0.35.0...v0.35.1

#### Bazel Module Snippet

```python
bazel_dep(name = "rules_swift_package_manager", version = "0.35.1")
```

#### Workspace Snippet

```python
load("@&#8203;bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "rules_swift_package_manager",
    sha256 = "9eddae9925a48774cfa65cfa905bf8f59dd7dc6ce831a07c4b945c57cdea1d77",
    urls = [
        "https://github.com/cgrindel/rules_swift_package_manager/releases/download/v0.35.1/rules_swift_package_manager.v0.35.1.tar.gz",
    ],
)

load("@&#8203;rules_swift_package_manager//:deps.bzl", "swift_bazel_dependencies")

swift_bazel_dependencies()

load("@&#8203;cgrindel_bazel_starlib//:deps.bzl", "bazel_starlib_dependencies")

bazel_starlib_dependencies()

### MARK: - Gazelle
### gazelle:repo bazel_gazelle

load("@&#8203;bazel_gazelle//:deps.bzl", "gazelle_dependencies")
load("@&#8203;rules_swift_package_manager//:go_deps.bzl", "swift_bazel_go_dependencies")
load("@&#8203;io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")

### Declare Go dependencies before calling go_rules_dependencies.
swift_bazel_go_dependencies()

go_rules_dependencies()

go_register_toolchains(version = "1.21.1")

gazelle_dependencies()

### MARK: - Swift Toolchain

http_archive(
    name = "build_bazel_rules_swift",

### Populate with your preferred release 
### https://github.com/bazelbuild/rules_swift/releases
)

load(
    "@&#8203;build_bazel_rules_swift//swift:repositories.bzl",
    "swift_rules_dependencies",
)
load("//:swift_deps.bzl", "swift_dependencies")

### gazelle:repository_macro swift_deps.bzl%swift_dependencies
swift_dependencies()

swift_rules_dependencies()

load(
    "@&#8203;build_bazel_rules_swift//swift:extras.bzl",
    "swift_rules_extra_dependencies",
)

swift_rules_extra_dependencies()
```

###
[`v0.35.0`](https://togithub.com/cgrindel/rules_swift_package_manager/releases/tag/v0.35.0)

[Compare
Source](https://togithub.com/cgrindel/rules_swift_package_manager/compare/v0.34.1...v0.35.0)

#### What's Changed

- chore: update README.md for v0.34.1 by
[@&#8203;cgrindel-app-token-generator](https://togithub.com/cgrindel-app-token-generator)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1120](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1120)
- chore(deps): update dependency marmelroy/phonenumberkit to from:
"3.7.11" by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1115](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1115)
- chore(deps): update dependency rules_proto to v6.0.2 by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1116](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1116)
- chore(deps): update dependency vapor/fluent to v4.11.0 by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1049](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1049)
- chore(deps): update dependency vapor/fluent-sqlite-driver to v4.7.3 by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1073](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1073)
- chore(deps): update dependency vapor/vapor to v4.102.0 by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1037](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1037)
- chore(deps): update dependency stripe/stripe-ios to from: "23.27.6" by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1119](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1119)
- fix(deps): update module github.com/spf13/cobra to v1.8.1 by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1121](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1121)
- chore(deps): update dependency apple/swift-log to from: "1.6.1" by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1122](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1122)
- chore(deps): update dependency apple/swift-markdown to v0.4.0 by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1123](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1123)
- docs: update quickstart guide to include swift package manager command
by [@&#8203;adincebic](https://togithub.com/adincebic) in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1128](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1128)
- chore: manually upgrade gazelle to 0.37.0 by
[@&#8203;cgrindel](https://togithub.com/cgrindel) in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1131](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1131)
- chore(deps): update dependency apple/swift-nio to v2.67.0 by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1124](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1124)
- chore(deps): update dependency apple/swift-nio to v2.68.0 by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1136](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1136)
- chore(deps): update dependency apple_support to v1.15.1 by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1125](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1125)
- chore(deps): update dependency cgrindel_bazel_starlib to v0.20.2 by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1130](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1130)
- chore(deps): update dependency firebase/firebase-ios-sdk to from:
"10.28.1" by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1132](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1132)
- chore(deps): update dependency geoswift/geoswift to from: "10.2.0" by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1133](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1133)
- chore(deps): update dependency nicklockwood/swiftformat to from:
"0.54.0" by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1134](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1134)
- chore(deps): update dependency onevcat/kingfisher to from: "7.12.0" by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1135](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1135)
- chore(deps): update dependency
pointfreeco/swift-composable-architecture to from: "1.11.2" by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1137](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1137)
- chore(deps): update dependency rules_apple to v3.6.0 by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1138](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1138)
- chore(deps): update dependency rules_xcodeproj to v2.4.0 by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1140](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1140)
- chore(deps): update dependency rules_swift to v1.18.0 by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1139](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1139)
- chore(deps): update dependency sdwebimage/sdwebimageswiftui to from:
"3.1.1" by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1141](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1141)
- chore(deps): update dependency protobuf to v27 by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1142](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1142)
- chore(deps): update dependency shakebugs/shake-ios to v17 by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1143](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1143)
- chore(deps): update dependency quick/quick to from: "7.6.1" by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1144](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1144)
- chore(deps): update dependency iterable/swift-sdk to from: "6.5.4" by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1145](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1145)
- chore(deps): update dependency bazel_skylib to v1.7.1 by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1127](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1127)
- chore(deps): update dependency bazel_skylib_gazelle_plugin to v1.7.1
by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1129](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1129)
- fix(deps): update golang.org/x/exp digest to
[`46b0784`](https://togithub.com/cgrindel/rules_swift_package_manager/commit/46b0784)
by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1151](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1151)
- chore(deps): update dependency soto-project/soto to v7 by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1152](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1152)
- chore(deps): update dependency firebase/firebase-ios-sdk to from:
"10.29.0" by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1153](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1153)
- chore(deps): Update rules_xcodeproj to 2.5.1 by
[@&#8203;brentleyjones](https://togithub.com/brentleyjones) in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1156](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1156)
- chore(deps): update dependency stripe/stripe-ios to from: "23.28.0" by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1158](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1158)
- chore(deps): update dependency vapor/vapor to v4.102.1 by
[@&#8203;cgrindel-self-hosted-renovate](https://togithub.com/cgrindel-self-hosted-renovate)
in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1161](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1161)
- fix: Use `swift_interop_hint` instead of `swift_module` tag by
[@&#8203;brentleyjones](https://togithub.com/brentleyjones) in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1107](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1107)

#### New Contributors

- [@&#8203;adincebic](https://togithub.com/adincebic) made their first
contribution in
[https://github.com/cgrindel/rules_swift_package_manager/pull/1128](https://togithub.com/cgrindel/rules_swift_package_manager/pull/1128)

**Full Changelog**:
cgrindel/rules_swift_package_manager@v0.34.1...v0.35.0

#### Bazel Module Snippet

```python
bazel_dep(name = "rules_swift_package_manager", version = "0.35.0")
```

#### Workspace Snippet

```python
load("@&#8203;bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
    name = "rules_swift_package_manager",
    sha256 = "51ab580ff68b6f214cadb2825094b09afbd27f7b4bee1bcb9370805e2d4413ab",
    urls = [
        "https://github.com/cgrindel/rules_swift_package_manager/releases/download/v0.35.0/rules_swift_package_manager.v0.35.0.tar.gz",
    ],
)

load("@&#8203;rules_swift_package_manager//:deps.bzl", "swift_bazel_dependencies")

swift_bazel_dependencies()

load("@&#8203;cgrindel_bazel_starlib//:deps.bzl", "bazel_starlib_dependencies")

bazel_starlib_dependencies()

### MARK: - Gazelle
### gazelle:repo bazel_gazelle

load("@&#8203;bazel_gazelle//:deps.bzl", "gazelle_dependencies")
load("@&#8203;rules_swift_package_manager//:go_deps.bzl", "swift_bazel_go_dependencies")
load("@&#8203;io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")

### Declare Go dependencies before calling go_rules_dependencies.
swift_bazel_go_dependencies()

go_rules_dependencies()

go_register_toolchains(version = "1.21.1")

gazelle_dependencies()

### MARK: - Swift Toolchain

http_archive(
    name = "build_bazel_rules_swift",

### Populate with your preferred release 
### https://github.com/bazelbuild/rules_swift/releases
)

load(
    "@&#8203;build_bazel_rules_swift//swift:repositories.bzl",
    "swift_rules_dependencies",
)
load("//:swift_deps.bzl", "swift_dependencies")

### gazelle:repository_macro swift_deps.bzl%swift_dependencies
swift_dependencies()

swift_rules_dependencies()

load(
    "@&#8203;build_bazel_rules_swift//swift:extras.bzl",
    "swift_rules_extra_dependencies",
)

swift_rules_extra_dependencies()
```

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about these
updates again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/bazel-contrib/rules_bazel_integration_test).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MjUuMSIsInVwZGF0ZWRJblZlciI6IjM3LjQyNS4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
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.

2 participants