Skip to content

Commit cfc6da4

Browse files
authored
Clean up docs and workflows after submodule removal (#6904)
Follow up that I forgot to push to the #6898 PR. - Stops setting up the submodule in GitHub workflows. - Stops checking if the submodule is up to date with dependabot. - Doesn't try to initialize the submodule in Firebase Studio. - Remove the instructions around the submodule from the README
1 parent 77a24e3 commit cfc6da4

File tree

7 files changed

+8
-59
lines changed

7 files changed

+8
-59
lines changed

.github/dependabot.yml

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,3 @@ updates:
2121
- "auto.dependencies"
2222
- "auto.npm"
2323
- "lang.javascript"
24-
- package-ecosystem: "gitsubmodule"
25-
directory: "/"
26-
schedule:
27-
interval: "daily"
28-
labels:
29-
- "auto.dependencies"
30-
- "auto.submodules"

.github/workflows/build.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,6 @@ jobs:
2626
timeout-minutes: 30
2727
steps:
2828
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
29-
with:
30-
submodules: recursive
3129
- uses: dart-lang/setup-dart@e51d8e571e22473a2ddebf0ef8a2123f0ab2c02c
3230
with:
3331
sdk: beta

.github/workflows/test.yml

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,6 @@ jobs:
3333
continue-on-error: ${{ matrix.experimental }}
3434
steps:
3535
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
36-
with:
37-
submodules: recursive
3836
- uses: dart-lang/setup-dart@e51d8e571e22473a2ddebf0ef8a2123f0ab2c02c
3937
with:
4038
sdk: ${{ matrix.sdk }}
@@ -56,8 +54,6 @@ jobs:
5654
runs-on: ubuntu-latest
5755
steps:
5856
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
59-
with:
60-
submodules: recursive
6157
- uses: dart-lang/setup-dart@e51d8e571e22473a2ddebf0ef8a2123f0ab2c02c
6258
with:
6359
sdk: beta
@@ -71,8 +67,6 @@ jobs:
7167
runs-on: ubuntu-latest
7268
steps:
7369
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
74-
with:
75-
submodules: recursive
7670
- uses: dart-lang/setup-dart@e51d8e571e22473a2ddebf0ef8a2123f0ab2c02c
7771
with:
7872
sdk: beta
@@ -86,8 +80,6 @@ jobs:
8680
runs-on: ubuntu-latest
8781
steps:
8882
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
89-
with:
90-
submodules: recursive
9183
- uses: dart-lang/setup-dart@e51d8e571e22473a2ddebf0ef8a2123f0ab2c02c
9284
with:
9385
sdk: beta
@@ -101,8 +93,6 @@ jobs:
10193
runs-on: ubuntu-latest
10294
steps:
10395
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
104-
with:
105-
submodules: recursive
10696
- uses: dart-lang/setup-dart@e51d8e571e22473a2ddebf0ef8a2123f0ab2c02c
10797
with:
10898
sdk: beta

.idx/dev.nix

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@
3838
workspace = {
3939
# Runs when a workspace is first created
4040
onCreate = {
41-
get-submodule = "git submodule update --init --recursive";
4241
dart-pub-get = "dart pub get";
4342
};
4443
# Runs when the workspace is (re)started

README.md

Lines changed: 8 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,6 @@ you probably don't need to build this site.
3333
Often you can make changes using the GitHub UI.
3434
We can stage the changes automatically in your pull request.
3535

36-
> [!IMPORTANT]
37-
> If you are cloning this repository locally,
38-
> follow the below instruction on cloning with its submodule.
39-
4036
If your change involves code samples, adds/removes pages, or affects navigation,
4137
do consider building and testing your work before submitting.
4238

@@ -66,49 +62,28 @@ and already the latest stable version:
6662
dart --version
6763
```
6864

69-
### Clone this repo and its submodules
70-
71-
> [!NOTE]
72-
> This repository has git _submodules_, which affects how you clone it.
73-
> The GitHub documentation has general help on
74-
> [forking][] and [cloning][] repos.
65+
### Clone this repo
7566

7667
If you're not a member of the Dart organization,
77-
we recommend you **create a fork** of this repo under your own account,
68+
we recommend you [create a fork][] of this repo under your own account,
7869
and then submit a PR from that fork.
7970

8071
Once you have a fork (or you're a Dart org member),
81-
_choose one_ of the following submodule-cloning techniques:
82-
83-
1. Clone the repo and its submodule at the same time
84-
using the `--recurse-submodules` option:
85-
86-
```terminal
87-
git clone --recurse-submodules https://github.com/dart-lang/site-www.git
88-
```
89-
90-
2. If you've already cloned the repo without its submodule,
91-
then run this command from the root of the repository:
72+
clone the repository with `git clone`:
9273

93-
```terminal
94-
git submodule update --init --recursive
95-
```
74+
```bash
75+
git clone https://github.com/dart-lang/site-www.git
76+
```
9677

97-
> [!NOTE]
98-
> At any time during development
99-
> you can use the `git submodule` command to refresh submodules:
100-
>
101-
> ```terminal
102-
> git pull && git submodule update --init --recursive
103-
> ```
78+
[create a fork]: https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo
10479

10580
## Set up your local environment and serve changes
10681

10782
Before you continue setting up the site infrastructure,
10883
verify the correct version of Dart is set up and available by
10984
following the instructions in [Get the prerequisites](#get-the-prerequisites).
11085

111-
1. _Optional:_ After cloning the repo and its submodules,
86+
1. _Optional:_ After cloning the repo,
11287
create a branch for your changes:
11388

11489
```terminal
@@ -200,8 +175,6 @@ check out the [excerpt updater package documentation][].
200175
[Build Status SVG]: https://github.com/dart-lang/site-www/workflows/build/badge.svg
201176
[OpenSSF Scorecard SVG]: https://api.securityscorecards.dev/projects/github.com/dart-lang/site-www/badge
202177
[Scorecard Results]: https://deps.dev/project/github/dart-lang%2Fsite-www
203-
[cloning]: https://docs.github.com/repositories/creating-and-managing-repositories/cloning-a-repository
204178
[Jaspr]: https://jaspr.site
205179
[Firebase]: https://firebase.google.com/
206-
[forking]: https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo
207180
[Repo on GitHub Actions]: https://github.com/dart-lang/site-www/actions?query=workflow%3Abuild+branch%3Amain

cloud_build/deploy.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
steps:
2-
- name: gcr.io/cloud-builders/git
3-
args: ['submodule', 'update', '--init', '--recursive']
42
- name: gcr.io/cloud-builders/git
53
args: [ 'fetch', '--unshallow' ]
64
- name: gcr.io/flutter-dev-230821/firebase-ghcli

cloud_build/stage.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
steps:
2-
- name: gcr.io/cloud-builders/git
3-
args: ['submodule', 'update', '--init', '--recursive']
42
- name: gcr.io/flutter-dev-230821/firebase-ghcli
53
# Build the site, deploy it to staging, then comment the link on the PR.
64
entrypoint: '/bin/bash'

0 commit comments

Comments
 (0)