Skip to content

Commit

Permalink
Adding contrib and small-index as submodules
Browse files Browse the repository at this point in the history
  • Loading branch information
adpi2 committed Jan 24, 2022
1 parent 27b1043 commit 975b9b3
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 22 deletions.
9 changes: 0 additions & 9 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,21 +1,12 @@
target/
.sass-cache
.idea
.esdata/
.postgresql*/
amm
sbt
server/scaladex.log
contrib/
bin/.coursier
bin/.scalafmt
.DS_Store
data/DATA-PID
scaladex.log
.bloop/
.metals/
**/project/metals.sbt
.bsp/
project/gitignore.sbt
http-client.env.json
*.http
6 changes: 6 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[submodule "small-index"]
path = small-index
url = [email protected]:scalacenter/scaladex-small-index.git
[submodule "contrib"]
path = contrib
url = [email protected]:scalacenter/scaladex-contrib.git
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
## General Overview

Scaladex is composed of four repositories: one source repository `scaladex`, two persistence repositories, `scaladex-contrib` and `scaladex-index`, and one configuration repository `scaladex-credentials`.
## Repositories

For development, you should prefer using `scaladex-small-index` that is a small subset of the original `scaladex-index` repository.
Scaladex is composed of four repositories:
- `scaladex`: The main repository, it contains the source files.
- `scala-credentials`: The configuration repository, it is private in the scalacenter organization because it contains some secret tokens.
- `scaladex-contrib`: Some resource files that can be contributed to by the community: the `claims.json` and the `non-standard.json` files and others.
- `scaladex-small-index` and `scaladex-index`: Some data repositories that can be used to initialize a Scaladex instance from scratch.

```
scaladex
├── scaladex
├── scaladex-contrib
├── scaladex-credentials
└── scaladex-index (or scaladex-small-index)
```
For development, you should only need to clone `scaladex`:
- `scaladex-credentials` and `scaladex-index` are only used in the remote `dev` and `prod` environments.
- `scaladex-contrib` and `scaladex-small-index` are submodules of `scaladex`.

## Requirements

Expand Down
6 changes: 2 additions & 4 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -108,11 +108,9 @@ lazy val infra = project
),
javaOptions ++= {
val base = (ThisBuild / baseDirectory).value
val index = base / "../scaladex-small-index/"
val credentials = base / "../scaladex-credentials"
val contrib = base / "../scaladex-contrib"
val index = base / "small-index"
val contrib = base / "contrib"
Seq(
s"-Dscaladex.filesystem.credentials=$credentials",
s"-Dscaladex.filesystem.index=$index",
s"-Dscaladex.filesystem.contrib=$contrib"
)
Expand Down
1 change: 1 addition & 0 deletions contrib
Submodule contrib added at 835d2c
1 change: 1 addition & 0 deletions small-index
Submodule small-index added at c2f660

0 comments on commit 975b9b3

Please sign in to comment.