Skip to content

Commit ea3d054

Browse files
committed
Update CI-related docs to current practices
1 parent 3b838de commit ea3d054

File tree

3 files changed

+8
-16
lines changed

3 files changed

+8
-16
lines changed

_pages/develop/appveyor.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,8 @@ title: AppVeyor
33
section: Extend:Development:Tools
44
---
55

6-
[AppVeyor](https://ci.appveyor.com/) is a tool for [continuous integration](/develop/ci) on [Windows](/platforms/windows) platforms. It is very useful for automating builds, deployment and other tasks.
7-
6+
{% include notice icon="note" content="SciJava projects now use Github Actions for CI. See the [GitHub Actions](/develop/github-actions) page for configuration instructions." %}
87

9-
# Services
10-
11-
Most [SciJava](/libs/scijava)-based project builds use [GitHub Actions](/develop/github-actions). However, some Windows-specific builds use AppVeyor.
8+
[AppVeyor](https://ci.appveyor.com/) is a tool for [continuous integration](/develop/ci) on [Windows](/platforms/windows) platforms. It is very useful for automating builds, deployment and other tasks.
129

13-
See e.g. the [ImageJ Launcher](https://ci.appveyor.com/project/scijava/imagej-launcher) build.
10+
Some [SciJava](/libs/scijava)-based projects used AppVeyor for Windows-specific portions of their builds, particularly in tandem with [Travis CI](/develop/travis) during the 2017-2021 era.

_pages/develop/github-actions.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ section: Extend:Development:Tools
1111

1212
- Perform builds of SciJava projects. Github Actions deploy `SNAPSHOT` builds to the [SciJava Maven repository](https://maven.scijava.org/) in response to pushes to each code repository's `main` branch. So any downstream projects depending on a version of `LATEST` for a given component will match the last successful Github build—i.e., the latest code on `main`.
1313
- Run each project's associated {% include wikipedia title='Unit testing' text='unit tests'%}. Github Actions is instrumental in early detection of new bugs introduced to the codebase.
14-
- Perform [releases](/develop/releasing) of [SciJava](/libs/scijava) projects. Github Actions deploys release builds to the appropriate Maven repository—typically either the SciJava Maven repository or [OSS Sonatype](https://oss.sonatype.org/).
14+
- Perform [releases](/develop/releasing) of [SciJava](/libs/scijava) projects. Github Actions deploys release builds to the appropriate Maven repository—typically either the SciJava Maven repository or [Maven Central via the Central Publisher Portal](https://central.sonatype.org/publish/publish-portal-guide/).
1515
- Keep the [javadoc](/develop/source#javadocs) site updated.
1616
- Keep other web resources updated.
1717

@@ -26,16 +26,11 @@ Deploying your library to a [Maven](/develop/maven) repository makes it availabl
2626

2727
## Instructions
2828

29-
- In order to add Github CI support to a repository, the secrets are needed: A) for deploying to Maven repositories; and B) in the case of deploying to OSS Sonatype, for GPG signing of artifacts.
29+
- In order to add Github CI support to a repository, the secrets are needed: A) for deploying to Maven repositories; and B) in the case of deploying to Maven Central, for GPG signing of artifacts.
3030
- If the secrets have been added to your organization, and you have push access to the relevant repository on GitHub, you can use the [github-actionify.sh script](https://github.com/scijava/scijava-scripts/blob/-/github-actionify.sh) with the `-f` flag to perform the needed operations.
31-
- The github-actionify script will return '[ERROR] Dirty working copy' if you have uncommited changes. If you get this error, check the status of the repository with `git status` and then run `github-actionify -f` again.
31+
- The github-actionify script will return `[ERROR] Dirty working copy` if you have uncommited changes. If you get this error, check the status of the repository with `git status` and then run `github-actionify -f` again.
3232
- If you need help, please ask [on the Image.sc Forum](https://forum.image.sc/) in the Development category, or in the [SciJava stream](https://imagesc.zulipchat.com/#narrow/channel/327237-SciJava) on the Image.sc Zulip.
3333

34-
## Configuration of JavaFX builds
35-
36-
- The workflows configured by the [github-actionify.sh script](https://github.com/scijava/scijava-scripts/blob/-/github-actionify.sh) do not include JavaFX.
37-
- To add support for JavaFX, edit the files contained in the folder `.github/workflows/` to match those found in other SciJava projects that depend on JavaFX, e.g. [FilamentDetector](https://github.com/fiji/FilamentDetector).
38-
3934
## Testing things which cannot run headless
4035

4136
If your tests require a display (i.e.: they do not pass when run [headless](/learn/headless)), you will get errors during the build process such as:
@@ -44,7 +39,7 @@ If your tests require a display (i.e.: they do not pass when run [headless](/lea
4439
Error: myTest Time elapsed: 0.097 s <<< ERROR!
4540

4641
You can fix this using [Xvfb](/learn/headless#xvfb-virtual-desktop) as follows.
47-
In your repository there is a file `.github/workflows/build-main.yml`.
42+
In your repository there is a file `.github/workflows/build.yml`.
4843
In this file there should be some lines that read:
4944

5045
- name: Set up CI environment

_pages/develop/travis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Travis CI
33
section: Extend:Development:Tools
44
---
55

6-
{% include notice icon="note" content="SciJava [CI](/develop/ci) has [migrated from Travis CI to Github Actions](https://forum.image.sc/t/scijava-ci-migration-from-travis-ci-to-github-actions/57573). See the [GitHub Actions](https://imagej.net/develop/github-actions) page for configuration instructions, including how to migrate existing projects from Travis CI." %}
6+
{% include notice icon="note" content="SciJava projects now use Github Actions for CI. See the [GitHub Actions](/develop/github-actions) page for configuration instructions." %}
77

88
{% include img src='logos/travis' align='right' width=150 caption='**Travis CI:** Build your code in the cloud!' %}
99

0 commit comments

Comments
 (0)