Skip to content

Commit 2a76018

Browse files
committed
architecture: remove notes about "dev profiles"
I'm considering removing them from pom-scijava in the future. In the meantime, let's consider them softly deprecated.
1 parent 9a689af commit 2a76018

File tree

1 file changed

+9
-15
lines changed

1 file changed

+9
-15
lines changed

_pages/develop/architecture.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -272,28 +272,22 @@ We sometimes use `SNAPSHOT` versions temporarily on topic branches. However, we
272272

273273
## Using snapshot couplings during development
274274

275-
For developing several components in parallel, it is very useful to switch to `SNAPSHOT` dependency couplings e.g., to test a [pull request](https://help.github.com/articles/checking-out-pull-requests-locally/).
275+
For developing several components in parallel, it can be useful to switch to `SNAPSHOT` dependency couplings.
276276

277-
There are two easy ways of going about this:
277+
You can override the version property of the dependency for which you wish to use a snapshot:
278278

279-
1. When a small number of snapshot couplings are needed, you can override the version property of the dependency for which you wish to use a snapshot:
280-
<properties>
281-
<scijava-common.version>LATEST</scijava-common.version>
282-
<enforcer.skip>true</enforcer.skip> <!-- ONLY while depending on a SNAPSHOT -->
283-
</properties>
284-
2. Alternately, if you wish to temporarily apply snapshot couplings en masse, you can switch on a "dev profile" (defined in the [`pom-scijava` parent POM](https://github.com/scijava/pom-scijava/blob/pom-scijava-12.0.0/pom.xml#L2542-L2547)) by creating one or more "dev token" files:
285-
- `~/.scijava/dev.imagej`
286-
- `~/.scijava/dev.imglib2`
287-
- `~/.scijava/dev.scifio`
288-
- `~/.scijava/dev.scijava`
289-
290-
These files need not have any content; their mere existence will trigger the dev profile associated with the named organization, causing all artifacts of that organization to become coupled as `SNAPSHOT`s.
279+
```xml
280+
<properties>
281+
<scijava-common.version>LATEST</scijava-common.version>
282+
<enforcer.skip>true</enforcer.skip> <!-- ONLY while depending on a SNAPSHOT -->
283+
</properties>
284+
```
291285

292286
In the case of Eclipse, you may need to "Update Maven project" in order to see the snapshot couplings go into effect; the shortcut {% include key keys='Alt|F5' %} while selecting the affected project(s) accomplishes this quickly.
293287

294288
{% include notice icon="warning" content='Current versions of the Eclipse Maven integration (tested with Eclipse Mars) fail to correctly resolve the `LATEST` version tag to `SNAPSHOT`s. If this happens to you, try specifying the version explicitly e.g. `2.0.0-SNAPSHOT` instead of using `LATEST`.' %}
295289

296-
Either way, ***Be sure to work on a topic branch while developing code in this fashion.*** You will need to clean up your Git history afterwards before merging things to the main branch, in order to achieve [reproducible builds](#reproducible-builds).
290+
***Be sure to work on a topic branch while developing code in this fashion.*** You will need to clean up your Git history afterwards before merging things to the main branch, in order to achieve [reproducible builds](#reproducible-builds).
297291

298292
# Versioning
299293

0 commit comments

Comments
 (0)