Skip to content

Commit

Permalink
Add convention to mark a package unsupported (#363)
Browse files Browse the repository at this point in the history
* Add convention to mark a package unsupported

This allows us to leave package installation scripts present in this
repo for users who may want to rebuild old projects with pinned old
versions of the package, while providing an escape hatch for CI that
would otherwise fail.

* CHANGELOG about unsupported

* rgeos unsupported
  • Loading branch information
mbaynton committed Oct 31, 2023
1 parent 52f79f5 commit eba91fe
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 3 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ jobs:
steps:
- uses: actions/checkout@v3
- name: Print Tests
run: echo "matrix=$(ls -1 -d packages/* | grep -v gsl | tr '\n' '\0' | xargs -0 -n 1 basename | jq -Rsc '. / "\n" - [""]')"
run: echo "matrix=$(./test-list.sh | jq -Rsc '. / "\n" - [""]')"
- name: List Tests As Output
id: list-tests
run: echo "matrix=$(ls -1 -d packages/* | grep -v gsl | tr '\n' '\0' | xargs -0 -n 1 basename | jq -Rsc '. / "\n" - [""]')" >> $GITHUB_OUTPUT
run: echo "matrix=$(./test-list.sh | jq -Rsc '. / "\n" - [""]')" >> $GITHUB_OUTPUT

test-package:
name: ${{ matrix.stack }} on ${{ matrix.os }}
Expand Down
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
## October 31st 2023

### Added
* Convention to mark packages as no longer officially supported. Packages with an `UNSUPPORTED` file
in their directory will not be subject to testing, but may still work for you, espeically if your
application uses an old version of the package.

Packages may be marked unsupported for a variety of reasons, but commonly because they have been
removed from CRAN.

### Removed
* `rgdal` and `rgeos` is marked unsupported because they were removed from CRAN.

## September 22nd 2023

### Added
Expand Down
1 change: 1 addition & 0 deletions packages/rgdal/UNSUPPORTED
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Removed from cran
1 change: 1 addition & 0 deletions packages/rgeos/UNSUPPORTED
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Removed from cran
2 changes: 1 addition & 1 deletion test
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ DIR=`dirname $0`
cd "${DIR}" || exit 1

if [ $# -eq 0 ]; then
PACKAGES=$(ls -1 -d $DIR/packages/* | grep -v gsl | tr '\n' '\0' | xargs -0 -n 1 basename)
PACKAGES=$(./test-list.sh)
else
PACKAGES=$@
fi
Expand Down
10 changes: 10 additions & 0 deletions test-list.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
#!/bin/bash

# Lists packages that are supported and testable.
all_packages=$(find packages/ -mindepth 1 -maxdepth 1 -type d)

for package in ${all_packages}; do
if [ ! -f "${package}"/UNSUPPORTED ]; then
basename "${package}"
fi
done

0 comments on commit eba91fe

Please sign in to comment.