Skip to content

Commit

Permalink
Add deprecation notes (#40)
Browse files Browse the repository at this point in the history
  • Loading branch information
CodeReaper authored Jul 2, 2024
1 parent 907cf09 commit c4bd60a
Show file tree
Hide file tree
Showing 14 changed files with 21 additions and 5 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/unit-tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
set +e
sh ./lane 2> result
[ $? -eq 1 ] || exit 1
echo 'The available lanes are:' > expected
printf 'Warning: lane is deprecated, see help for details\nThe available lanes are:\n' > expected
diff -q expected result || { echo "Unexpected difference:"; diff expected result; exit 1; }
- name: Test help argument
Expand Down Expand Up @@ -128,7 +128,7 @@ jobs:
set +e
sh ./lane 2> result
[ $? -eq 1 ] || exit 1
printf 'The available lanes are:\n say\n touch\n' > expected
printf 'Warning: lane is deprecated, see help for details\nThe available lanes are:\n say\n touch\n' > expected
diff -q expected result || { echo "Unexpected difference:"; diff expected result; exit 1; }
lane-d-requirements:
Expand Down
1 change: 1 addition & 0 deletions lane
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
OLD_PWD=$(pwd)
LANED_PWD=$(realpath "${0}.d")

echo 'Warning: lane is deprecated, see help for details' >&2
trap 'set +x; cd "$OLD_PWD" >/dev/null 2>&1;' 0
trap 'exit 2' 1 2 3 15

Expand Down
2 changes: 2 additions & 0 deletions lane.d/google-api-docs-sheets-download/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ SYNOPSIS

DESCRIPTION
```
DEPRECATED - in version 1.0.0 this action is available as 'lane translations download [OPTIONS]', but will require a JSON type service account key.
Downloads a Sheet from Google Docs.
```

Expand Down
4 changes: 3 additions & 1 deletion lane.d/google-api-jwt-generate/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ SYNOPSIS

DESCRIPTION
```
DEPRECATED - this functionality will be built into 'lane translations download [OPTIONS]' in version 1.0.0.
Constructs JWT generation request for Google APIs and outputs a JWT.
The purpose is to faciliate token generation for other usages of the Google APIs.
Expand All @@ -38,4 +40,4 @@ Authentication happens using a specially created .p12 file issued by Google whic

You get this .p12 key by creating a "Service Account Key", which if you do not have a service account, requires you to first create a service account.

Creating both an account and a key is explaining here: https://developers.google.com/identity/protocols/oauth2/service-account#creatinganaccount
Creating both an account and a key is explained here: https://developers.google.com/identity/protocols/oauth2/service-account#creatinganaccount
1 change: 0 additions & 1 deletion lane.d/google-api-jwt-generate/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,3 @@ OPTIONS
-p
A path to the .p12 file issued by Google. See authentication section in the full help.
```

1 change: 1 addition & 0 deletions lane.d/google-api-jwt-generate/run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ if [ ! -f "$p12" ]; then
exit 4
fi

echo 'Warning: this action is deprecated, see help for details' >&2
DIR=$(mktemp -dq)

trap 'set +x; rm -fr $DIR >/dev/null 2>&1' 0
Expand Down
2 changes: 2 additions & 0 deletions lane.d/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ SYNOPSIS

DESCRIPTION
```
DEPRECATED - the functionality of basically executing a script can be provided by an actual script, make, ant and similiar tools. Use them instead.
`lane` is a task automation helper.
You can organize tasks in lanes. A task is written as a shell script.
Expand Down
2 changes: 2 additions & 0 deletions lane.d/mobile-static-resources-images/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ SYNOPSIS

DESCRIPTION
```
DEPRECATED - this functionality is now built into Xcode 15 and newer. See https://developer.apple.com/documentation/xcode-release-notes/xcode-15-release-notes#Asset-Catalogs
Searches an assets directory for .imagesets and generates swift code.
The purpose is to enable compilation checks for image references to embedded assets.
Expand Down
1 change: 1 addition & 0 deletions lane.d/mobile-static-resources-images/run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ fi
parent=$(dirname "$output")
mkdir -p "$parent" 2>/dev/null

echo 'Warning: this action is deprecated, see help for details' >&2
{
echo '// swiftlint:disable all'
echo 'import UIKit'
Expand Down
2 changes: 2 additions & 0 deletions lane.d/mobile-update-translations/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ SYNOPSIS

DESCRIPTION
```
DEPRECATED - in version 1.0.0 this action is available as 'lane translations generate [OPTIONS]'
Reads a CSV file and uses configuration strings to generate static resource files for android or ios.
Each translated string can have '%<digit>'-style placeholders, however the number of placeholder for each translated language must be the same.
Expand Down
2 changes: 2 additions & 0 deletions lane.d/shell-github-action-semver-compare/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ SYNOPSIS

DESCRIPTION
```
DEPRECATED - this action basically wraps a few lines of shell commands with almost no complexity. Use them directly.
Compares two semver-style versions.
The exit code will indicate if the current version is considered higher than the main version.
The output includes a GitHub-Action-style group text for easier debugging, and an error message when exit code > 0.
Expand Down
1 change: 1 addition & 0 deletions lane.d/shell-github-action-semver-compare/run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ fi
exit 10
}

echo 'Warning: this action is deprecated, see help for details' >&2
verify=$(printf '%s\n%s' "$main" "$current" | sort -t '.' -k 1,1 -k 2,2 -k 3,3 -k 4,4 -k 5,5 -g | tail -n1)
[ "$main" = "$verify" ] && {
echo 'Version must be greater than version on main.'
Expand Down
1 change: 1 addition & 0 deletions lane.d/shell-run-github-workflow-tests/run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ if [ ! -f "$file" ]; then
exit 111
fi

echo 'Warning: this action is deprecated, see help for details' >&2
DIR=$(mktemp -dq)

trap 'set +x; rm -fr $DIR >/dev/null 2>&1' 0
Expand Down
2 changes: 1 addition & 1 deletion lanes/test
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
lane shell-run-github-workflow-tests -i .github/workflows/tests.yaml
lane shell-run-github-workflow-tests -i .github/workflows/unit-tests.yaml
shellcheck lane.d/*/run.sh lane
shellcheck --exclude=SC2148,SC2034,SC2206,SC2296 lane.d/*.dotrc

0 comments on commit c4bd60a

Please sign in to comment.